FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Docs: Polish `sys.monitoring` docs by gaogaotiantian · Pull Request #110532 · python/cpython · GitHub

/ cpython Public

Docs: Polish sys.monitoring docs - #110532

Merged
brandtbucher merged 1 commit into
python:mainfrom
gaogaotiantian:sys-monitoring-docs
Oct 18, 2023
ConversationCommits (1)ChecksFiles changed
Merged

Docs: Polish sys.monitoring docs#110532
brandtbucher merged 1 commit into
python:mainfrom
gaogaotiantian:sys-monitoring-docs

Conversation

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

Copy link
Copy Markdown
Member

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 added docs Documentation in the Doc dir skip issue skip news labels Oct 8, 2023
brandtbucher approved these changes Oct 18, 2023
View reviewed changes

brandtbucher left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Great improvement!

brandtbucher commented Oct 18, 2023

Copy link
Copy Markdown
Member

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

brandtbucher added the needs backport to 3.12 only security fixes label Oct 18, 2023
brandtbucher merged commit 1991694 into python:main Oct 18, 2023

miss-islington-app Bot commented Oct 18, 2023

Copy link
Copy Markdown

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 Bot commented Oct 18, 2023

Copy link
Copy Markdown

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
[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 removed the needs backport to 3.12 only security fixes label Oct 18, 2023

gaogaotiantian commented Oct 18, 2023

Copy link
Copy Markdown
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 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
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
pythonGH-103082: Clean up the sys.monitoring docs (pythonGH-110532)
effa03d
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

brandtbucher brandtbucher approved these changes
markshannon Awaiting requested review from markshannon

Assignees

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

Back | FazBrowse Home | New Git URL