Skip to content

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

Merged
gpshead merged 1 commit into
python:masterfrom
gpshead:logging_doc_clarification
Mar 24, 2020
Merged

[docs] Clarify a guarantee of the logging module.#19132
gpshead merged 1 commit into
python:masterfrom
gpshead:logging_doc_clarification

Conversation

@gpshead

@gpshead gpshead commented Mar 24, 2020

Copy link
Copy Markdown
Member

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

gpshead commented Mar 24, 2020

Copy link
Copy Markdown
Member Author

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
Copy Markdown
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 <greg@krypto.org>
@bedevere-bot

Copy link
Copy Markdown

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 <greg@krypto.org>
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