Skip to content
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.

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

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

Merged
merged 2 commits into from
Sep 25, 2024

Conversation

Damien-Chen
Copy link
Contributor

@Damien-Chen Damien-Chen commented Aug 22, 2024

As in #123223, these arugment are mentioned at the top of the same page, so adding hyperlink so that when user at the buttom of the page, they are able to review the definition of those argument convinently.


📚 Documentation preview 📚: https://cpython-previews--123231.org.readthedocs.build/

Comment on lines 591 to 593
The definition of *category* and *lineno* are same as defined
at the top of :ref:`warning-filter` field.

Copy link
Contributor

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~

Copy link
Contributor

@nanjekyejoannah nanjekyejoannah left a comment

Choose a reason for hiding this comment

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

A note makes sense here

@nanjekyejoannah nanjekyejoannah merged commit 828583a into python:main Sep 25, 2024
25 checks passed
@picnixz picnixz added needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels Sep 25, 2024
@miss-islington-app
Copy link

Thanks @Damien-Chen for the PR, and @nanjekyejoannah for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Thanks @Damien-Chen for the PR, and @nanjekyejoannah for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 25, 2024
…ngs: (pythonGH-123231)

* Adding hyperlink of argument

* Modify as reviewer suggested
(cherry picked from commit 828583a)

Co-authored-by: Damien <81557462+Damien-Chen@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Sep 25, 2024

GH-124527 is a backport of this pull request to the 3.12 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 25, 2024
…ngs: (pythonGH-123231)

* Adding hyperlink of argument

* Modify as reviewer suggested
(cherry picked from commit 828583a)

Co-authored-by: Damien <81557462+Damien-Chen@users.noreply.github.com>
@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Sep 25, 2024
@bedevere-app
Copy link

bedevere-app bot commented Sep 25, 2024

GH-124528 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Sep 25, 2024
Yhg1s pushed a commit that referenced this pull request Sep 26, 2024
…ings: (GH-123231) (#124528)

gh-123223: Adding hyperlink of argument in warnings.catch_warnings: (GH-123231)

* Adding hyperlink of argument

* Modify as reviewer suggested
(cherry picked from commit 828583a)

Co-authored-by: Damien <81557462+Damien-Chen@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants