GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Docs: Polish `sys.monitoring` docs by gaogaotiantian · Pull Request #110532 · python/cpython

Conversation

@gaogaotiantian

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

Uh oh!

There was an error while loading. Please reload this page.

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/

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@gaogaotiantian
Polish sys.monitoring docs
2e1fb46
@gaogaotiantian gaogaotiantian added docs Documentation in the Doc dir skip issue skip news labels Oct 8, 2023
@gaogaotiantian
gaogaotiantian requested a review from markshannon October 8, 2023 22:30
@bedevere-app bedevere-app Bot added the awaiting review label Oct 8, 2023
brandtbucher
brandtbucher approved these changes Oct 18, 2023
View reviewed changes

@brandtbucher brandtbucher left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Great improvement!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-app bedevere-app Bot added awaiting merge and removed awaiting review labels Oct 18, 2023
@brandtbucher

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. ;)
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@brandtbucher brandtbucher added the needs backport to 3.12 only security fixes label Oct 18, 2023
@brandtbucher
brandtbucher merged commit 1991694 into python:main Oct 18, 2023
@miss-islington-app

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!
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the awaiting merge label Oct 18, 2023
@miss-islington-app

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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@miss-islington-app miss-islington-app Bot assigned brandtbucher Oct 18, 2023
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 <[email protected]>
@brandtbucher brandtbucher removed the needs backport to 3.12 only security fixes label Oct 18, 2023
@gaogaotiantian

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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@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

Uh oh!

There was an error while loading. Please reload this page.

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.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@gaogaotiantian @brandtbucher
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.