◐ Shell
reader mode source ↗
Skip to content

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
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

@sobolevn 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 sobolevn requested review from AA-Turner and hugovk February 1, 2024 07:51
@sobolevn sobolevn requested a review from vsajip as a code owner February 1, 2024 07:51
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels Feb 1, 2024
@bedevere-app bedevere-app Bot mentioned this pull request Feb 1, 2024
Open
@sobolevn @hugovk
Update Doc/howto/logging.rst …
493256c 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@hugovk hugovk merged commit dc01b91 into python:main Feb 1, 2024
@miss-islington-app

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

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
@sobolevn @hugovk @miss-islington
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

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 bedevere-app Bot removed the needs backport to 3.11 only security fixes label Feb 1, 2024
@hugovk

hugovk commented Feb 1, 2024

Copy link
Copy Markdown
Member

Thanks! 🧹📖

hugovk added a commit that referenced this pull request Feb 1, 2024
@miss-islington @sobolevn @hugovk
[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

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 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
@sobolevn @hugovk
[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
@hugovk @sobolevn
[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
@sobolevn @hugovk @aisk
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk left review comments

@vsajip vsajip vsajip approved these changes

@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

Assignees

@hugovk 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

@sobolevn @hugovk @vsajip