-
-
Notifications
You must be signed in to change notification settings - Fork 30.9k
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-101100: Fix sphinx warnings in howto/logging.rst
#114846
Conversation
|
||
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for updating my knowledge.
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Sorry, @sobolevn and @hugovk, I could not cleanly backport this to
|
GH-114872 is a backport of this pull request to the 3.11 branch. |
Thanks! 🧹📖 |
GH-114878 is a backport of this pull request to the 3.12 branch. |
…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>
…) (#114878) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
…14846) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Before:
Changes:
.. versionchanged
in one placeraiseExceptions
doc, using its docstring fromlogging/__init__.py
📚 Documentation preview 📚: https://cpython-previews--114846.org.readthedocs.build/