Skip to content

gh-123223: Adding hyperlink of argument in warnings.catch_warnings: #123231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 25, 2024
Merged

gh-123223: Adding hyperlink of argument in warnings.catch_warnings: #123231

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
418ad8e
Adding hyperlink of argument
Damien-Chen Aug 22, 2024
eaa491e
Modify as reviewer suggested
Damien-Chen Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Doc/library/warnings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,9 @@ Available Context Managers
Each object in the list has attributes with the same names as the arguments to
:func:`showwarning`.

The definition of *category* and *lineno* are same as defined
at the top of :ref:`warning-filter` field.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would put it after the documentation on the action argument.

	See :ref:`warning-filter` for the meaning of the *category* and *lineno*
	parameters.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Understood~

The *module* argument takes a module that will be used instead of the
module returned when you import :mod:`warnings` whose filter will be
protected. This argument exists primarily for testing the :mod:`warnings`
Expand Down