Docs: Fix Sphinx warnings in logging.rst #108139
Conversation
- Add missing markup to some methods - Silence links to __init__ methods
Doc/library/logging.rst
Outdated
| to :class:`LoggerAdapter`. These methods delegate to the underlying logger. | ||
|
|
||
| .. versionchanged:: 3.6 | ||
| Attribute :attr:`manager` and method :meth:`_log` were added, which | ||
| Attribute :attr:`!manager` and method :meth:`!_log` were added, which | ||
| delegate to the underlying logger and allow adapters to be nested. | ||
|
|
||
| .. versionchanged:: 3.13 | ||
| Remove the undocumented ``warn()`` method which was an alias to the | ||
| ``warning()`` method. | ||
| Remove the undocumented :meth:`!warn`` method which was an alias to the | ||
| :meth:`!warning` method. | ||
|
|
||
| .. versionchanged:: 3.13 | ||
| The *merge_extra* argument was added. |
There was a problem hiding this comment.
This entire section (starting "In addition to the above ...") should be indented by 3 spaces to fall under .. class:: LoggerAdapter
There was a problem hiding this comment.
Indeed; good observation!
There was a problem hiding this comment.
There was another paragraph needing indentation, I've pushed a commit to fix (hope you don't mind!)
A
|
Thanks @erlend-aasland for the PR, and @vsajip for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
|
Sorry, @erlend-aasland and @vsajip, I could not cleanly backport this to |
|
Sorry, @erlend-aasland and @vsajip, I could not cleanly backport this to |
|
GH-108174 is a backport of this pull request to the 3.12 branch. |
(cherry picked from commit c735e79) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
|
GH-108175 is a backport of this pull request to the 3.11 branch. |
(cherry picked from commit c735e79) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
__init__methods📚 Documentation preview 📚: https://cpython-previews--108139.org.readthedocs.build/