Skip to content

Commit

Permalink
Fix documentation about the *action* keyword argument
Browse files Browse the repository at this point in the history
  • Loading branch information
tantale committed Feb 23, 2020
1 parent 0894a0f commit 794bbf9
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion deprecated/classic.py
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ def some_old_function(x, y):
The *action* keyword argument allow you to locally change the warning filtering.
*action* can be one of "error", "ignore", "always", "default", "module", or "once".
If ``None`` or empty, the the global filtering mechanism is used.
If ``None``, empty or missing, the the global filtering mechanism is used.
See: `The Warnings Filter`_ in the Python documentation.
.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion deprecated/sphinx.py
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ def deprecated(*args, **kwargs):
- "action":
A warning filter used to activate or not the deprecation warning.
Can be one of "error", "ignore", "always", "default", "module", or "once".
By default the deprecation warning is always emitted (the value is "always").
If ``None``, empty or missing, the the global filtering mechanism is used.
- "category":
The warning category to use for the deprecation warning.
Expand Down

0 comments on commit 794bbf9

Please sign in to comment.