From 4995bc30af9231b56a3dec46c4035d01b432c60e Mon Sep 17 00:00:00 2001 From: Dan Alvizu Date: Thu, 30 Dec 2021 15:43:12 -0700 Subject: [PATCH] Update capture-warnings.rst doc on syntax Re-order and clarify that the syntax format of pytest is the exact same as python's -W syntax --- doc/en/how-to/capture-warnings.rst | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/doc/en/how-to/capture-warnings.rst b/doc/en/how-to/capture-warnings.rst index 7e877b4d3..71d0fe97c 100644 --- a/doc/en/how-to/capture-warnings.rst +++ b/doc/en/how-to/capture-warnings.rst @@ -42,8 +42,18 @@ Running pytest now produces this output: -- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html ======================= 1 passed, 1 warning in 0.12s ======================= -The ``-W`` flag can be passed to control which warnings will be displayed or even turn -them into errors: +Controlling warnings +-------------------- + +Similar to Python's `warning filter` and :option:`-W option ` flag, pytest provides +its own a ``-W`` flag to control which warnings are ignored, displayed, or turned into +errors. See the `warning filter` documentation for more +advanced use-cases. + +.. _`warning filter`: https://docs.python.org/3/library/warnings.html#warning-filter + +This code sample shows how to treat any ``UserWarning`` category class of warning +as an error: .. code-block:: pytest @@ -96,9 +106,11 @@ all other warnings into errors. When a warning matches more than one option in the list, the action for the last matching option is performed. +Syntax +------ + Both ``-W`` command-line option and ``filterwarnings`` ini option are based on Python's own -:option:`-W option ` and :func:`warnings.simplefilter`, so please refer to those sections in the Python -documentation for other examples and advanced usage. + .. _`filterwarnings`: