Skip to content

Commit

Permalink
Tweak wording of wildcard docs
Browse files Browse the repository at this point in the history
  • Loading branch information
seddonym committed Aug 29, 2024
1 parent 4a3021c commit d3efc54
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/contract_types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
Contract types
==============


.. _forbidden modules:

Forbidden modules
-----------------

Expand Down Expand Up @@ -337,6 +340,9 @@ Options used by multiple contracts
Wildcards are supported. ``*`` stands in for a module name, without including subpackages. ``**`` includes
subpackages too.

Note that this wildcard format is only supported for the ``ignore_imports`` fields. It can't currently be used for
other fields, such as in the ``source_modules`` field of a :ref:`forbidden modules` contract.

Examples:

- ``mypackage.*``: matches ``mypackage.foo`` but not ``mypackage.foo.bar``.
Expand All @@ -352,5 +358,3 @@ Options used by multiple contracts
- ``error``: Error if there are any unmatched expressions (default).
- ``warn``: Print a warning for each unmatched expression.
- ``none``: Do not alert.

Note that wildcards are ONLY implemented for ``ignore_imports`` and won't work in contracts.

0 comments on commit d3efc54

Please sign in to comment.