8000 gh-94700: Rewrite the logging.Formatter API ref in structured form (GH-94701) by CAM-Gerlach · Pull Request #94701 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-94700: Rewrite the logging.Formatter API ref in structured form (GH-94701) #94701

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 1 commit into from
Jul 9, 2022
Merged

gh-94700: Rewrite the logging.Formatter API ref in structured form (GH-94701) #94701

merged 1 commit into from
Jul 9, 2022

Conversation

CAM-Gerlach
Copy link
Member
@CAM-Gerlach CAM-Gerlach commented Jul 9, 2022 •
edited by bedevere-bot
Loading

As discussed on #94700 and the Discourse thread, this revises the logging.Formatter class API doc to use a structured, explicit parameter list, include all key details (param descriptions, types and defaults) in a much more accessible, readable format, and make it much more concise and direct while retaining all the same information by trimming redundancy, duplication and verbosity, as well as improving clarity.

Preview:

image

Resolves #94700

@CAM-Gerlach CAM-Gerlach requested a review from vsajip as a code owner July 9, 2022 02:24
@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir labels Jul 9, 2022
@CAM-Gerlach CAM-Gerlach changed the title gh-94700: Rewrite the logging.Formatter API ref in structured sphinxdoc gh-94700: Rewrite the logging.Formatter API ref in structured form Jul 9, 2022
@vsajip vsajip changed the title gh-94700: Rewrite the logging.Formatter API ref in structured form gh-94700: Rewrite the logging.Formatter API ref in structured form (GH-94701) Jul 9, 2022
@vsajip vsajip merged commit 761eeb6 into python:main Jul 9, 2022
@CAM-Gerlach CAM-Gerlach mentioned this pull request Aug 1, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vsajip vsajip vsajip approved these changes

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.

Add structured, explicit parameter list to logging.Formatter constructor
3 participants
@CAM-Gerlach @vsajip @bedevere-bot
0