Skip to content

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

Merged
markshannon merged 18 commits into
python:mainfrom
faster-cpython:doc-669
Sep 5, 2023
Merged

GH-103082: Document PEP-669: Low Impact Monitoring for CPython#107772
markshannon merged 18 commits into
python:mainfrom
faster-cpython:doc-669

Conversation

@markshannon

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

Copy link
Copy Markdown
Member

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

@jacobtylerwallsjacobtylerwalls left a comment

Copy link
Copy Markdown
Contributor

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

Comment threadDoc/library/sys.monitoring.rst Outdated
AA-Turner
AA-Turner reviewed Aug 13, 2023
View reviewed changes
Comment threadDoc/library/sys.monitoring.rst Outdated
Comment threadDoc/library/sys.monitoring.rst Outdated
Comment threadDoc/library/sys.monitoring.rst Outdated
Comment threadDoc/library/sys.monitoring.rst Outdated
Comment threadDoc/library/sys.monitoring.rst
Comment threadDoc/library/sys.monitoring.rst Outdated
Comment threadDoc/library/sys.monitoring.rst Outdated
Comment threadDoc/library/sys.monitoring.rst Outdated
Comment threadDoc/library/sys.monitoring.rst Outdated
Comment threadDoc/library/sys.monitoring.rst Outdated
@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

@AA-TurnerAA-Turner 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.

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

Comment threadDoc/library/sys.monitoring.rst Outdated
Comment threadDoc/library/sys.monitoring.rst Outdated
Comment threadDoc/library/sys.monitoring.rst Outdated
Comment threadDoc/library/sys.monitoring.rst Outdated
Comment threadDoc/library/sys.monitoring.rst Outdated
Comment threadDoc/library/sys.monitoring.rst Outdated
Comment threadDoc/library/sys.monitoring.rst Outdated
Comment threadDoc/library/sys.monitoring.rst Outdated
@AA-Turner

AA-Turner commented Sep 1, 2023

Copy link
Copy Markdown
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.

AA-Turner
AA-Turner reviewed Sep 1, 2023
View reviewed changes
Comment threadDoc/library/sys.monitoring.rst Outdated
markshannonand 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:mainSep 5, 2023
@Yhg1s

Yhg1s commented Sep 5, 2023

Copy link
Copy Markdown
Member

Is this getting backported to 3.12?

@markshannon

markshannon commented Sep 5, 2023

Copy link
Copy Markdown
MemberAuthor

Yes, it should be.

@markshannonmarkshannon added the needs backport to 3.12 only security fixes label Sep 5, 2023
@miss-islington

miss-islington commented Sep 5, 2023

Copy link
Copy Markdown
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

bedevere-bot commented Sep 5, 2023

Copy link
Copy Markdown

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

@bedevere-botbedevere-bot removed the needs backport to 3.12 only 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: DocumentPEP-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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AA-TurnerAA-TurnerAA-Turner left review comments
+1 more reviewer
@jacobtylerwallsjacobtylerwallsjacobtylerwalls left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip 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