gh-94700: Rewrite the logging.Formatter API ref in structured form (GH-94701)#94701
Merged
vsajip merged 1 commit intopython:mainfrom Jul 9, 2022
Merged
Conversation
vsajip
approved these changes
Jul 9, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As discussed on #94700 and the Discourse thread, this revises the
logging.Formatterclass 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:
Resolves #94700