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

Docs: Polish sys.monitoring docs #110532

Merged
merged 1 commit into from
Oct 18, 2023
Merged

Docs: Polish sys.monitoring docs #110532

merged 1 commit into from
Oct 18, 2023

Conversation

gaogaotiantian
Copy link
Member

@gaogaotiantian gaogaotiantian commented Oct 8, 2023 •
edited by github-actions bot
Loading

Polish sys.monitoring docs so it looks like other Python docs.

  • Replaced a lot of raw code type with the commonly used exception or function links.
  • Added monitoring-event directive for all the events (similart to dis instructions and pdb commands)
  • Added DISABLE, MISSING and NO_EVENT constant explanation.
  • Added versionadded
  • Used *arg* for arguments which is the standard for most Python docs.
  • Unified the display in callback function section
  • Fixed a couple of grammar issues or vague words.

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

@gaogaotiantian gaogaotiantian added docs Documentation in the Doc dir skip issue skip news labels Oct 8, 2023
brandtbucher
brandtbucher approved these changes Oct 18, 2023
View reviewed changes
Copy link
Member

@brandtbucher brandtbucher left a comment

Choose a reason for hiding this comment

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

Great improvement!

@brandtbucher
Copy link
Member

...also, the title of this PR definitely made me think that you were translating these docs for readers in Poland. ;)

@brandtbucher brandtbucher added the needs backport to 3.12 bug and security fixes label Oct 18, 2023
@brandtbucher brandtbucher merged commit 1991694 into python:main Oct 18, 2023
29 checks passed
@miss-islington-app
Copy link

Thanks @gaogaotiantian for the PR, and @brandtbucher for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington-app
Copy link

Sorry, @gaogaotiantian and @brandtbucher, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 19916941172844f9c52d7a6dce95efaa23035772 3.12

brandtbucher pushed a commit to brandtbucher/cpython that referenced this pull request Oct 18, 2023
@gaogaotiantian @brandtbucher
[3.12] pythonGH-103082: Clean up the sys.monitoring docs (pythonGH-11…
2cc9770 
…0532).

(cherry picked from commit 1991694)

Co-authored-by: Tian Gao <gaogaotiantian@hotmail.com>
@brandtbucher brandtbucher removed the needs backport to 3.12 bug and security fixes label Oct 18, 2023
@gaogaotiantian
Copy link
Member Author

...also, the title of this PR definitely made me think that you were translating these docs for readers in Poland. ;)

That would be a brand new thing for me :) must learn Polish now!

sys.monitoring page is not translated in any language now as far as I know, English version only. Probably because it's a super new thing for the users.

@gaogaotiantian gaogaotiantian deleted the sys-monitoring-docs branch October 18, 2023 23:28
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@gaogaotiantian @aisk
pythonGH-103082: Clean up the sys.monitoring docs (pythonGH-110532)
9269d3a
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@gaogaotiantian @Glyphack
pythonGH-103082: Clean up the sys.monitoring docs (pythonGH-110532)
effa03d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brandtbucher brandtbucher brandtbucher approved these changes

@markshannon markshannon Awaiting requested review from markshannon

Assignees

@brandtbucher brandtbucher

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

Successfully merging this pull request may close these issues.
2 participants
@gaogaotiantian @brandtbucher