Skip to content

logging.LogRecord missing param type information #95516

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
Closed
CAM-Gerlach opened this issue Aug 1, 2022 · 0 comments · Fixed by #95517
Closed

logging.LogRecord missing param type information #95516

CAM-Gerlach opened this issue Aug 1, 2022 · 0 comments · Fixed by #95517
Assignees
@CAM-Gerlach
Labels
docs Documentation in the Doc dir

Comments

@CAM-Gerlach
Copy link
Member

As another docs improvement in the series started by #94700 , logging.LogRecord currently has a great structured parameter list, but is missing type information for the parameters, which in many cases leads to ambiguity. Additionally, some of the parameter descriptions could be clarified.
@CAM-Gerlach CAM-Gerlach added the docs Documentation in the Doc dir label Aug 1, 2022
@CAM-Gerlach CAM-Gerlach self-assigned this Aug 1, 2022
CAM-Gerlach added a commit to CAM-Gerlach/cpython that referenced this issue Aug 1, 2022
@CAM-Gerlach
pythonGH-95516: Add param types and clarify param descriptions of Log…
517bb43 
…Record
@CAM-Gerlach CAM-Gerlach mentioned this issue Aug 1, 2022
Merged
@bedevere-bot bedevere-bot mentioned this issue Aug 2, 2022
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 2, 2022
@CAM-Gerlach @miss-islington
pythongh-95516: Add param types and clarify param descriptions of Log…
459842c 
…Record (pythonGH-95517)

(cherry picked from commit 75a6441)

Co-authored-by: CAM Gerlach <[email protected]>
vsajip pushed a commit that referenced this issue Aug 2, 2022
@CAM-Gerlach
gh-95516: Add param types and clarify param descriptions of LogRecord (…
75a6441 
…GH-95517)
@bedevere-bot bedevere-bot mentioned this issue Aug 2, 2022
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 2, 2022
@CAM-Gerlach @miss-islington
pythongh-95516: Add param types and clarify param descriptions of Log…
c3392f6 
…Record (pythonGH-95517)

(cherry picked from commit 75a6441)

Co-authored-by: CAM Gerlach <[email protected]>
vsajip pushed a commit that referenced this issue Aug 2, 2022
@miss-islington @CAM-Gerlach
[3.11] gh-95516: Add param types and clarify param descriptions of Lo…
eff6778 
…gRecord (GH-95517) (GH-95566)

Co-authored-by: CAM Gerlach <[email protected]>
erlend-aasland pushed a commit that referenced this issue Aug 2, 2022
@miss-islington @CAM-Gerlach
gh-95516: Add param types and clarify param descriptions of LogRecord (…
a1579ad 
…GH-95517) (#95565)

(cherry picked from commit 75a6441)

Co-authored-by: CAM Gerlach <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@CAM-Gerlach CAM-Gerlach

Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

gh-95516: Add param types and clarify param descriptions of LogRecord (GH-95517) CAM-Gerlach/cpython
2 participants
@CAM-Gerlach and others