The Wayback Machine - https://web.archive.org/web/20250528031144/https://github.com/python/cpython/pull/113424
Skip to content

GH-113350: Changed the python docs 3.12.1 in logging HOWTO #113424

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

Closed
wants to merge 2 commits into from

Conversation

vaishnavi192
Copy link
Contributor

@vaishnavi192 vaishnavi192 commented Dec 23, 2023

Fix #113350 - Basic logging tutorial: Confusing matrix and use of word "above"

This Pull Request changes the documentation of logging-cookbook.rst and logging.rst from "above" word to required changes.


📚 Documentation preview 📚: https://cpython-previews--113424.org.readthedocs.build/

@vaishnavi192 vaishnavi192 requested a review from vsajip as a code owner December 23, 2023 08:34
@ghost
Copy link

ghost commented Dec 23, 2023

All commit authors signed the Contributor License Agreement.
CLA signed

Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

Some lines are extra long. Please split them.

@@ -333,7 +333,7 @@ Suppose you configure logging with the following JSON:
}

This configuration does *almost* what we want, except that ``sys.stdout`` would
show messages of severity ``ERROR`` and above as well as ``INFO`` and
show messages of severity ``ERROR`` and only events of this level and higher severity will be tracked as well as ``INFO`` and
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
show messages of severity ``ERROR`` and only events of this level and higher severity will be tracked as well as ``INFO`` and
show messages of severity ``ERROR`` and higher, as well as ``INFO`` and

And please remove the trailing space at the end of the change in the other file.

Copy link
Member

@vsajip vsajip left a comment

Choose a reason for hiding this comment

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

I feel that my suggested wording is less clumsy than "this level and higher severity and above".

@@ -333,7 +333,7 @@ Suppose you configure logging with the following JSON:
}

This configuration does *almost* what we want, except that ``sys.stdout`` would
show messages of severity ``ERROR`` and above as well as ``INFO`` and
show messages of severity ``ERROR`` and only events of this level and higher severity will be tracked as well as ``INFO`` and
Copy link
Member

Choose a reason for hiding this comment

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

Would prefer the wording "only events of this severity and higher will be tracked" here.

The default level is ``WARNING``, which means that only events of this level
and above will be tracked, unless the logging package is configured to do
otherwise.
The default level is ``WARNING``, which means that only events of this level and higher severity and above will be tracked,
Copy link
Member

Choose a reason for hiding this comment

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

Would prefer the wording "only events of this severity and higher will be tracked" here.

@bedevere-app
Copy link

bedevere-app bot commented Dec 23, 2023

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

And if you don't make the requested changes, you will be put in the comfy chair!

@AlexWaygood AlexWaygood added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Dec 24, 2023
@vaishnavi192
Copy link
Contributor Author

okay yeah! I will do changes today itself! sorry for replying late my laptop got into some trouble.

@hugovk
Copy link
Member

hugovk commented Dec 26, 2023

Please could you also edit the PR title to be more descriptive?

@vaishnavi192
Copy link
Contributor Author

I have made the requested changes; please review again

@hugovk
Copy link
Member

hugovk commented Dec 26, 2023

@vaishnavi192 Remember to git push your changes.

@hugovk
Copy link
Member

hugovk commented Dec 27, 2023

Closing as a duplicate of #113491.

@hugovk hugovk closed this Dec 27, 2023
@vaishnavi192
Copy link
Contributor Author

vaishnavi192 commented Dec 27, 2023

@hugovk just wanted to confirm the issue is solved now right? I did it correctly? Open source is bit confusing for now😅

@hugovk
Copy link
Member

hugovk commented Dec 27, 2023

Yes, it's solved now, and the issue is closed: #113350

What happened:

  • You made this first PR from your main branch
  • You then made updates in another documentation branch and made a second PR

Next time, I recommend making a new branch, and a PR from that branch, and avoid making any changes directly to your main.

Thank you for your contribution!

@vaishnavi192
Copy link
Contributor Author

Okay got it! Thank you @hugovk for being so welcoming to new contributors. It helps a lot!......Looking forward to contribute more in Python.😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting changes docs Documentation in the Doc dir needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Basic logging tutorial: Confusing matrix and use of word "above"
5 participants