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-103082: Document PEP-669: Low Impact Monitoring for CPython #107772

Merged
merged 18 commits into from
Sep 5, 2023
Merged

GH-103082: Document PEP-669: Low Impact Monitoring for CPython #107772

merged 18 commits into from
Sep 5, 2023

Conversation

markshannon
Copy link
Member

@markshannon markshannon commented Aug 8, 2023 •
edited by bedevere-bot
Loading

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news labels Aug 8, 2023
@markshannon markshannon changed the title Document PEP-669: Low Impact Monitoring for CPython GH-103082: Document PEP-669: Low Impact Monitoring for CPython Aug 8, 2023
@bedevere-bot bedevere-bot mentioned this pull request Jul 22, 2023
Closed
4 tasks
jacobtylerwalls
jacobtylerwalls reviewed Aug 9, 2023
View reviewed changes
Copy link
Contributor

@jacobtylerwalls jacobtylerwalls left a comment

Choose a reason for hiding this comment

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

Spotted a typo while here, cheers

Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
AA-Turner
AA-Turner reviewed Aug 13, 2023
View reviewed changes
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
Doc/library/sys.monitoring.rst Show resolved Hide resolved
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
@markshannon markshannon marked this pull request as ready for review August 31, 2023 10:40
AA-Turner
AA-Turner reviewed Sep 1, 2023
View reviewed changes
Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

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

Suggestions to remove double-spaces, and to remove an unneeded sys.monitoring prefix from the function definitions -- they'll be added by Sphinx regardless as of the .. module:: directive at the top of the file, and removing them helps with line length/readability.

A

Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
Doc/library/sys.monitoring.rst Outdated Show resolved Hide resolved
@AA-Turner
Copy link
Member

The patch mentiond for conf.py is:

diff --git a/Doc/conf.py b/Doc/conf.py
index 16fd8bf2571..901b977fd71 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -157,6 +157,8 @@
     ('envvar', 'USER'),
     ('envvar', 'USERNAME'),
     ('envvar', 'USERPROFILE'),
+    # sys.monitoring ignores
+    ('py:class', 'range(6)'),
 ]

 # Temporary undocumented names.

markshannon and others added 8 commits September 5, 2023 02:16
@markshannon
Remove double space
200e4a3
@markshannon @AA-Turner
Update Doc/library/sys.monitoring.rst
fb16167 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@markshannon @AA-Turner
Update Doc/library/sys.monitoring.rst
bfb3b1d 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@markshannon @AA-Turner
Update Doc/library/sys.monitoring.rst
0833922 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@markshannon @AA-Turner
Update Doc/library/sys.monitoring.rst
6364315 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@markshannon @AA-Turner
Update Doc/library/sys.monitoring.rst
4894333 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@markshannon @AA-Turner
Apply suggestions from code review
a943679 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@markshannon
Drop use of range(6) to avoid confusing sphinx
002e744
@markshannon markshannon merged commit 8b515f6 into python:main Sep 5, 2023
15 checks passed
@Yhg1s
Copy link
Member

Yhg1s commented Sep 5, 2023

Is this getting backported to 3.12?

@markshannon
Copy link
Member Author

Yes, it should be.

@markshannon markshannon added the needs backport to 3.12 bug and security fixes label Sep 5, 2023
@miss-islington
Copy link
Contributor

Thanks @markshannon for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@bedevere-bot
Copy link

GH-108909 is a backport of this pull request to the 3.12 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.12 bug and security fixes label Sep 5, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 5, 2023
@markshannon @miss-islington
pythonGH-103082: Document PEP-669: Low Impact Monitoring for CPython (p…
75d5382 
…ythonGH-107772)

(cherry picked from commit 8b515f6)

Co-authored-by: Mark Shannon <mark@hotpy.org>
@markshannon markshannon deleted the doc-669 branch September 5, 2023 12:52
Yhg1s pushed a commit that referenced this pull request Sep 5, 2023
@miss-islington @markshannon
[3.12] GH-103082: Document PEP-669: Low Impact Monitoring for CPython (…
578b3ea 
…GH-107772) (#108909)

GH-103082: Document PEP-669: Low Impact Monitoring for CPython (GH-107772)
(cherry picked from commit 8b515f6)

Co-authored-by: Mark Shannon <mark@hotpy.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AA-Turner AA-Turner AA-Turner left review comments

@jacobtylerwalls jacobtylerwalls jacobtylerwalls left review comments

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

Successfully merging this pull request may close these issues.
6 participants
@markshannon @AA-Turner @Yhg1s @miss-islington @bedevere-bot @jacobtylerwalls