Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweak wording of wildcard docs #234

Merged
merged 1 commit into from
Aug 29, 2024
Merged

Tweak wording of wildcard docs #234

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/contract_types.rst
View file
Open in desktop
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.
Loading