diff --git a/doc/source/development/contributing_codebase.rst b/doc/source/development/contributing_codebase.rst index 45d4e24b0df51..b8d568428c156 100644 --- a/doc/source/development/contributing_codebase.rst +++ b/doc/source/development/contributing_codebase.rst @@ -537,7 +537,7 @@ Preferred ``pytest`` idioms test and does not check if the test will fail. If this is the behavior you desire, use ``pytest.skip`` instead. If a test is known to fail but the manner in which it fails -is not meant to be captured, use ``pytest.mark.xfail`` It is common to use this method for a test that +is not meant to be captured, use ``pytest.mark.xfail``. It is common to use this method for a test that exhibits buggy behavior or a non-implemented feature. If the failing test has flaky behavior, use the argument ``strict=False``. This will make it so pytest does not fail if the test happens to pass. Using ``strict=False`` is highly undesirable, please use it only as a last resort.