Skip to content
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

gh-114494: Change logging docstring to bool for exec_info #114558

Merged
merged 3 commits into from
Jan 26, 2024
Merged

gh-114494: Change logging docstring to bool for exec_info #114558

merged 3 commits into from
Jan 26, 2024

Conversation

tristanpank
Copy link
Contributor

@tristanpank tristanpank commented Jan 25, 2024 •
edited by bedevere-app bot
Loading

@cpython-cla-bot CPython CLA Bot
Copy link

cpython-cla-bot bot commented Jan 25, 2024 •
edited
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app bedevere-app bot mentioned this pull request Jan 25, 2024
Closed
@bedevere-app
Copy link

bedevere-app bot commented Jan 25, 2024

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

sunmy2019
sunmy2019 reviewed Jan 25, 2024
View reviewed changes
Misc/NEWS.d/next/Documentation/2024-01-25-15-58-31.gh-issue-114494.sgtopX.rst Outdated
@@ -0,0 +1 @@
I updated the logging docstring to use bool instead of integer parameters for exec_info. Originally, it was written as exec_info=1 in 6 places, which I changed to exec_info=True.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't state what you have done. State what change is affecting the user.

Example:
Minor fixes for logging docstring.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this NEWS

@sunmy2019
Copy link
Member

NEWS should state what you want the user to know, not how you solved the problem.

But this fix is too trivial so I am gonna let you skip this NEWS.

sunmy2019
sunmy2019 requested changes Jan 25, 2024
View reviewed changes
Misc/NEWS.d/next/Documentation/2024-01-25-15-58-31.gh-issue-114494.sgtopX.rst Outdated
@@ -0,0 +1 @@
I updated the logging docstring to use bool instead of integer parameters for exec_info. Originally, it was written as exec_info=1 in 6 places, which I changed to exec_info=True.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this NEWS

@serhiy-storchaka serhiy-storchaka added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Jan 25, 2024
@serhiy-storchaka serhiy-storchaka merged commit 07236f5 into python:main Jan 26, 2024
29 checks passed
@miss-islington-app
Copy link

Thanks @tristanpank for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Sorry, @tristanpank and @serhiy-storchaka, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 07236f5b39a2e534cf190cd4f7c73300d209520b 3.11

@serhiy-storchaka serhiy-storchaka added needs backport to 3.12 bug and security fixes and removed needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Jan 26, 2024
@miss-islington-app
Copy link

Thanks @tristanpank for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@serhiy-storchaka serhiy-storchaka removed the needs backport to 3.12 bug and security fixes label Jan 26, 2024
@serhiy-storchaka serhiy-storchaka added the needs backport to 3.12 bug and security fixes label Jan 26, 2024
@miss-islington-app
Copy link

Thanks @tristanpank for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@serhiy-storchaka serhiy-storchaka added needs backport to 3.12 bug and security fixes and removed needs backport to 3.12 bug and security fixes labels Jan 27, 2024
@miss-islington-app
Copy link

Thanks @tristanpank for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@serhiy-storchaka serhiy-storchaka mentioned this pull request Jan 27, 2024
Open
@bedevere-app
Copy link

bedevere-app bot commented Mar 2, 2024

GH-116242 is a backport of this pull request to the 3.11 branch.

@serhiy-storchaka serhiy-storchaka removed the needs backport to 3.12 bug and security fixes label Mar 2, 2024
@serhiy-storchaka serhiy-storchaka removed their assignment Mar 2, 2024
serhiy-storchaka added a commit that referenced this pull request Mar 2, 2024
@serhiy-storchaka @tristanpank
[3.11] gh-114494: Change logging docstring to bool for exec_info (GH-…
9485566 
…114558) (GH-116242)

(cherry picked from commit 07236f5)

Co-authored-by: Tristan Pank <tristanpank@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sunmy2019 sunmy2019 sunmy2019 requested changes

@vsajip vsajip vsajip approved these changes

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

Assignees
No one assigned
Labels
skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@tristanpank @sunmy2019 @vsajip @serhiy-storchaka