Skip to content

gh-102873: logging.LogRecord docs: improve description of msg parameter #102875

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Mar 24, 2023
Merged

gh-102873: logging.LogRecord docs: improve description of msg parameter #102875

merged 2 commits into from
Mar 24, 2023

Conversation

aminalaee
Copy link
Contributor

@aminalaee aminalaee commented Mar 21, 2023 •
edited by bedevere-bot
Loading

@aminalaee aminalaee requested a review from vsajip as a code owner March 21, 2023 16:11
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news labels Mar 21, 2023
@bedevere-bot bedevere-bot mentioned this pull request Mar 21, 2023
Closed
@ghost
Copy link

ghost commented Mar 21, 2023 •
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

AlexWaygood
AlexWaygood reviewed Mar 21, 2023
View reviewed changes
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

Thanks!

AlexWaygood
AlexWaygood approved these changes Mar 21, 2023
View reviewed changes
Copy link
Member

@AlexWaygood AlexWaygood left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM, thanks! I'll wait a few days before merging in case @vsajip has any objections, though, since he's the primary maintainer for logging :)

Here's a link directly to the docs preview for this class: https://deploy-preview-102875--python-cpython-preview.netlify.app/library/logging.html#logging.LogRecord

@AlexWaygood AlexWaygood added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Mar 21, 2023
@AlexWaygood AlexWaygood changed the title gh-102873: Update logging LogRecord argument types gh-102873: logging.LogRecord docs: improve description of msg parameter Mar 21, 2023
@AlexWaygood AlexWaygood merged commit f2e5a6e into python:main Mar 24, 2023
@miss-islington
Copy link
Contributor

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

@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Mar 24, 2023
@bedevere-bot
Copy link

GH-103004 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Mar 24, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 24, 2023
@aminalaee @AlexWaygood @miss-islington
pythongh-102873: logging.LogRecord docs: improve description of msg…
fd3c8c2 
… parameter (pythonGH-102875)

(cherry picked from commit f2e5a6e)

Co-authored-by: Amin Alaee <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 24, 2023
@aminalaee @AlexWaygood @miss-islington
pythongh-102873: logging.LogRecord docs: improve description of msg…
e39145f 
… parameter (pythonGH-102875)

(cherry picked from commit f2e5a6e)

Co-authored-by: Amin Alaee <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
miss-islington added a commit that referenced this pull request Mar 24, 2023
@miss-islington @aminalaee @AlexWaygood
gh-102873: logging.LogRecord docs: improve description of msg param…
cbffc3a 
…eter (GH-102875)

(cherry picked from commit f2e5a6e)

Co-authored-by: Amin Alaee <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
@aminalaee aminalaee deleted the update-logging-logrecord-argument-types branch March 24, 2023 15:08
miss-islington added a commit that referenced this pull request Mar 24, 2023
@miss-islington @aminalaee @AlexWaygood
gh-102873: logging.LogRecord docs: improve description of msg param…
c834a4c 
…eter (GH-102875)

(cherry picked from commit f2e5a6e)

Co-authored-by: Amin Alaee <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
Fidget-Spinner pushed a commit to Fidget-Spinner/cpython that referenced this pull request Mar 27, 2023
@aminalaee @AlexWaygood @Fidget-Spinner
pythongh-102873: logging.LogRecord docs: improve description of msg…
a11fcbb 
… parameter (python#102875)

Co-authored-by: Alex Waygood <[email protected]>
warsaw pushed a commit to warsaw/cpython that referenced this pull request Apr 11, 2023
@aminalaee @AlexWaygood @warsaw
pythongh-102873: logging.LogRecord docs: improve description of msg…
4e950aa 
… parameter (python#102875)

Co-authored-by: Alex Waygood <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlexWaygood AlexWaygood AlexWaygood approved these changes

@vsajip vsajip Awaiting requested review from vsajip vsajip is a code owner

Assignees
No one assigned
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.

logging module LogRecord can accept non-str msg but it's not documented
4 participants
@aminalaee @miss-islington @bedevere-bot @AlexWaygood