From 84c664ecd23e60c9210382c67bea1b9ddaca58c4 Mon Sep 17 00:00:00 2001 From: Nicholas Bunn Date: Fri, 2 Aug 2024 11:37:49 +0100 Subject: [PATCH] Update Documentation --- src/importlinter/contracts/forbidden.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/importlinter/contracts/forbidden.py b/src/importlinter/contracts/forbidden.py index 3e84e9d..bced66b 100644 --- a/src/importlinter/contracts/forbidden.py +++ b/src/importlinter/contracts/forbidden.py @@ -30,6 +30,9 @@ class ForbiddenContract(Contract): - unmatched_ignore_imports_alerting: Decides how to report when the expression in the `ignore_imports` set is not found in the graph. Valid values are "none", "warn", "error". Default value is "error". + - as_packages: Whether to treat the source and forbidden modules as packages. If False, + each of the modules passed in will be treated as a module rather than a + package. Default behaviour is True (treat modules as packages). """ type_name = "forbidden"