FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-101100: Fix sphinx warnings in `howto/logging.rst` by sobolevn · Pull Request #114846 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-101100: Fix sphinx warnings in howto/logging.rst - #114846

Merged
hugovk merged 3 commits into
python:mainfrom
sobolevn:issue-101100-howto-logging
Feb 1, 2024
ConversationCommits (3)ChecksFiles changed
Merged

gh-101100: Fix sphinx warnings in howto/logging.rst#114846
hugovk merged 3 commits into
python:mainfrom
sobolevn:issue-101100-howto-logging

Conversation

sobolevn commented Feb 1, 2024 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Before:

/Users/sobolev/Desktop/cpython2/Doc/howto/logging.rst:521: WARNING: py:func reference target not found: setLevel
/Users/sobolev/Desktop/cpython2/Doc/howto/logging.rst:1000: WARNING: py:class reference target not found: handlers.BufferingFormatter
/Users/sobolev/Desktop/cpython2/Doc/howto/logging.rst:1032: WARNING: py:data reference target not found: raiseExceptions
/Users/sobolev/Desktop/cpython2/Doc/howto/logging.rst:1037: WARNING: py:data reference target not found: raiseExceptions
/Users/sobolev/Desktop/cpython2/Doc/howto/logging.rst:1037: WARNING: py:data reference target not found: raiseExceptions
/Users/sobolev/Desktop/cpython2/Doc/howto/logging.rst:1074: WARNING: py:func reference target not found: expensive_func1
/Users/sobolev/Desktop/cpython2/Doc/howto/logging.rst:1074: WARNING: py:func reference target not found: expensive_func2

Changes:

  1. I remixed how pre-3.2 behaviour was specified using .. versionchanged in one place
  2. Added raiseExceptions doc, using its docstring from logging/__init__.py

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

sobolevn added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Feb 1, 2024
sobolevn requested review from AA-Turner and hugovk February 1, 2024 07:51
sobolevn requested a review from vsajip as a code owner February 1, 2024 07:51
bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels Feb 1, 2024
bedevere-app Bot mentioned this pull request Feb 1, 2024
Closed
vsajip reviewed Feb 1, 2024
View reviewed changes
Comment thread Doc/howto/logging.rst

For versions of Python prior to 3.2, the behaviour is as follows:
The event is output using a 'handler of last resort', stored in
:data:`lastResort`. This internal handler is not associated with any

vsajip Feb 1, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

lastResort, raiseExceptions etc. are module-level attributes - how come we don't use the :attr: role for them? Is my understanding of that role outdated?

sobolevn Feb 1, 2024 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

We use data with module level variables to define: https://www.sphinx-doc.org/en/master/usage/domains/python.html#directive-py-data and reference them: https://www.sphinx-doc.org/en/master/usage/domains/python.html#role-py-data :)

vsajip Feb 1, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks for updating my knowledge.

hugovk reviewed Feb 1, 2024
View reviewed changes
Comment thread Doc/howto/logging.rst Outdated
Update Doc/howto/logging.rst
493256c 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
hugovk merged commit dc01b91 into python:main Feb 1, 2024

miss-islington-app Bot commented Feb 1, 2024

Copy link
Copy Markdown

Thanks @sobolevn for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington-app Bot commented Feb 1, 2024

Copy link
Copy Markdown

Sorry, @sobolevn and @hugovk, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker dc01b919c721f43ad024ba444a5d19541370e581 3.12

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 1, 2024
pythongh-101100: Fix sphinx warnings in howto/logging.rst (pythonGH…
cc7c88b 
…-114846)

(cherry picked from commit dc01b91)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

bedevere-app Bot commented Feb 1, 2024

Copy link
Copy Markdown

GH-114872 is a backport of this pull request to the 3.11 branch.

bedevere-app Bot removed the needs backport to 3.11 only security fixes label Feb 1, 2024

hugovk commented Feb 1, 2024

Copy link
Copy Markdown
Member

Thanks! 🧹📖

hugovk added a commit that referenced this pull request Feb 1, 2024
[3.11] gh-101100: Fix sphinx warnings in howto/logging.rst (GH-114846…
95f18f9 
…) (#114872)

gh-101100: Fix sphinx warnings in `howto/logging.rst` (GH-114846)

(cherry picked from commit dc01b91)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

bedevere-app Bot commented Feb 1, 2024

Copy link
Copy Markdown

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

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Feb 1, 2024
hugovk added a commit to hugovk/cpython that referenced this pull request Feb 1, 2024
[3.12] pythongh-101100: Fix sphinx warnings in howto/logging.rst (p…
5de5176 
…ythonGH-114846)

(cherry picked from commit dc01b91)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Feb 1, 2024
[3.12] gh-101100: Fix sphinx warnings in howto/logging.rst (GH-114846…
cc5870a 
…) (#114878)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
pythongh-101100: Fix sphinx warnings in howto/logging.rst (python#1…
7be5a92 
…14846)


Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

hugovk hugovk left review comments
vsajip vsajip approved these changes
AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

Assignees

hugovk

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL