gh-151946: Fix Sphinx reference warnings in logging.handlers#152220
gh-151946: Fix Sphinx reference warnings in logging.handlers#152220BHUVANSH855 wants to merge 3 commits into
Conversation
Documentation build overview
49 files changed ·
|
BHUVANSH855
force-pushed
the
gh-151946-logging-sphinx-warnings
branch
from
4e30421 to
11ee589
Compare
BHUVANSH855
requested review from
AA-Turner,
StanFromIreland and
hugovk
as code owners
vsajip
left a comment
vsajip
left a comment
There was a problem hiding this comment.
I'm also not sure if some people might think from these changes that streams have to inherit from IOBase, which they don't - as long as they obey duck-typing rules.
| string, for example '/dev/log'. In this case, a Unix domain socket is used to | ||
| send the message to the syslog. If *facility* is not specified, | ||
| :const:`LOG_USER` is used. The type of socket opened depends on the | ||
| :const:`~syslog.LOG_USER` is used. The type of socket opened depends on the |
There was a problem hiding this comment.
This isn't correct - LOG_USER and other such values are not imported from syslog. They are bit-shifted while computing the priority.
There was a problem hiding this comment.
I have made the requested changes; please review again.
Specifically, I changed the stream method references to implementation-neutral !write/!flush references to avoid implying that streams must inherit from IOBase, and changed LOG_USER to !LOG_USER since it is not imported from the syslog module.
I also verified that the documentation builds successfully with:
make -C Doc html SPHINXOPTS="-n -W --keep-going"
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
BHUVANSH855
force-pushed
the
gh-151946-logging-sphinx-warnings
branch
from
11ee589 to
4bfba97
Compare
|
I have made the requested changes; please review again. |
|
Thanks for making the requested changes! @vsajip: please review the changes made to this pull request. |
|
I have made the requested changes; please review again. |
|
Thanks for making the requested changes! @vsajip: please review the changes made to this pull request. |
|
Please avoid asking more than once for a re-review unless some time has passed (usually after 2-3 weeks). And please don't update the PR using the "Update branch" button unless there is a reason to (like fixing the CI that may have failed on main but is now fixed) as it creates noise. See https://devguide.python.org/getting-started/pull-request-lifecycle/#update-branch-button. In addition, avoid force-pushing once a review has been given. It makes incremental review close to impossible. |
3 participants
Summary
Fix Sphinx reference warnings in
Doc/library/logging.handlers.rstby updating ambiguous cross-references to fully qualified references where appropriate and marking implementation-specific names that should not be cross-referenced.The changes include:
loggingclasses and constants.iobase classes.!where cross-references are not intended.Issue
gh-151946
Testing
make -C Doc html SPHINXOPTS="-n -W --keep-going"The documentation builds successfully with no Sphinx warnings.