@@ -140,7 +140,7 @@ In this case stubtest will correctly complain:
140140
141141 To fix this, you can add an ``allowlist `` entry:
142142
143- .. code-block: ini
143+ .. code-block :: ini
144144
145145 # Allowlist entries in `allowlist.txt` file:
146146
@@ -150,17 +150,21 @@ To fix this, you can add an ``allowlist`` entry:
150150 And now when running stubtest with ``--allowlist=allowlist.txt ``,
151151no errors will be generated anymore.
152152
153- Allowlists also support regular expressions.
154- They might be useful to ignore many similar errors at once.
155- If some CI workers have ``optional_expensive_dep `` installed stubtest will complain:
153+ Allowlists also support regular expressions,
154+ which can be useful to ignore many similar errors at once.
155+ They can also be useful for suppressing stubtest errors that occur sometimes,
156+ but not on every CI run. For example, if some CI workers have
157+ ``optional_expensive_dep `` installed, stubtest might complain with this message
158+ on those workers if you had the ``ex.second `` allowlist entry:
156159
157- .. code-block: ini
160+ .. code-block :: ini
158161
159162 note: unused allowlist entry ex.second
160163 Found 1 error (checked 1 module)
161164
162- Changing ``ex.second `` to be ``(ex\.second)? `` will make this error optional.
163- And stubtest will not fail with and without ``optional_expensive_dep ``.
165+ Changing ``ex.second `` to be ``(ex\.second)? `` will make this error optional,
166+ meaning that stubtest will pass whether or not a CI runner
167+ has``optional_expensive_dep`` installed.
164168
165169CLI
166170***
0 commit comments