Skip to content
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

[docs] Clarify a guarantee of the logging module. #19132

Merged
merged 1 commit into from
Mar 24, 2020

Conversation

gpshead
Copy link
Member

@gpshead gpshead commented Mar 24, 2020

When no additional arguments are passed to logging.debug() and related
methods, no % operation is performed on the passed in message.

When no additional arguments are passed to logging.debug() and related
methods, no % operation is performed on the passed in message.
@gpshead
Copy link
Member Author

gpshead commented Mar 24, 2020

This simple documentation addition is motivated by someone thinking that this isn't a guarantee of the logging module because it isn't mentioned in the docs. It has been this implemented this way (and I can't imagine why it would ever be otherwise).

implemented here https://github.com/python/cpython/blob/master/Lib/logging/__init__.py#L368 with more details in the comment here https://github.com/python/cpython/blob/master/Lib/logging/__init__.py#L293

@gpshead gpshead self-assigned this Mar 24, 2020
@gpshead gpshead merged commit 9b8e74c into python:master Mar 24, 2020
@miss-islington
Copy link
Contributor

Thanks @gpshead for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

@gpshead gpshead deleted the logging_doc_clarification branch March 24, 2020 16:48
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 24, 2020
When no additional arguments are passed to logging.debug() and related
methods, no % operation is performed on the passed in message.
(cherry picked from commit 9b8e74c)

Co-authored-by: Gregory P. Smith <[email protected]>
@bedevere-bot
Copy link

GH-19138 is a backport of this pull request to the 3.8 branch.

miss-islington added a commit that referenced this pull request Mar 24, 2020
When no additional arguments are passed to logging.debug() and related
methods, no % operation is performed on the passed in message.
(cherry picked from commit 9b8e74c)

Co-authored-by: Gregory P. Smith <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants