From 4f57470286f1a44211925c60993073fadff74d75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Boulogne?= Date: Sun, 17 Jul 2016 22:46:37 +0200 Subject: [PATCH] fix docstring to remove WARNING: Inline substitution_reference --- skimage/_shared/_warnings.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/skimage/_shared/_warnings.py b/skimage/_shared/_warnings.py index d397d8e9..e6c43d32 100644 --- a/skimage/_shared/_warnings.py +++ b/skimage/_shared/_warnings.py @@ -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: