Skip to content

logging.Formatter docs: Add missing validate parameter, clarify style parameter #15222

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

Merged
merged 2 commits into from
Sep 9, 2019

Conversation

drothlis
Copy link
Contributor

  • The validate parameter was missing from the constructor's signature (it was already documented in the text lower down, but missing from the signature).
  • Clarify that the style parameter is for the fmt parameter, not for log messages. On my first read of the documentation I thought this was saying that logging had built-in support for {format} style log messages.

This is already documented in the text lower down, it was just missing
from the constructor's signature.
I found this confusing: on my first read of the documentation I thought
this was saying that `logging` had built-in support for `{format}`
style log messages.
@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately we couldn't find an account corresponding to your GitHub username on bugs.python.org (b.p.o) to verify you have signed the CLA (this might be simply due to a missing "GitHub Name" entry in your b.p.o account settings). This is necessary for legal reasons before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for your contribution, we look forward to reviewing it!

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Aug 12, 2019
@tirkarthi
Copy link
Member

cc: @vsajip

@vsajip vsajip merged commit 4f0f9f0 into python:master Sep 9, 2019
DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
websurfer5 pushed a commit to websurfer5/cpython that referenced this pull request Jul 20, 2020
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.

5 participants