wassname/scikit-image
1
0
Fork 0
mirror of https://github.com/wassname/scikit-image.git synced 2026-09-12 12:50:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix docstring to remove WARNING: Inline substitution_reference

Browse Source
This commit is contained in:
François Boulogne
2016-07-17 22:46:37 +02:00
parent 749f5876ce
commit 4f57470286
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skimage/_shared/_warnings.py
+4 -5
View File
@@ -82,7 +82,6 @@ def expected_warnings(matching):
matching : list of strings or compiled regexes
Regexes for the desired warning to catch
Examples
--------
>>> from skimage import data, img_as_ubyte, img_as_float
@@ -96,14 +95,14 @@ def expected_warnings(matching):
pattern(s).
Raises a ValueError if any match was not found or an unexpected
warning was raised.
Allows for three types of behaviors: "and", "or", and "optional" matches.
Allows for three types of behaviors: `and`, `or`, and `optional` matches.
This is done to accomodate different build enviroments or loop conditions
that may produce different warnings. The behaviors can be combined.
If you pass multiple patterns, you get an orderless "and", where all of the
If you pass multiple patterns, you get an orderless `and`, where all of the
warnings must be raised.
If you use the "|" operator in a pattern, you can catch one of several
If you use the `|` operator in a pattern, you can catch one of several
warnings.
Finally, you can use "|\A\Z" in a pattern to signify it as optional.
Finally, you can use `|\A\Z` in a pattern to signify it as optional.
"""
with all_warnings() as w: