-
-
Notifications
You must be signed in to change notification settings - Fork 30.3k
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.
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
GH-90744: Fix erroneous doc links in the sys module #101319
Conversation
furkanonder
commented
Jan 25, 2023
•
edited by bedevere-bot
Loading
edited by bedevere-bot
- Issue: In documentation same-named attributes erroneously link to built-in names #90744
This removes the bad links, but they're no longer formatted as code:
And when running Sphinx in nit-picky mode (re: #101100), we're getting warnings about all of those:
So shall we change all of them like this? - :const:`max`
+ ``max`` And we could also do the macros too, although that will also require adjusting the column width: - DBL_MAX
+ ``DBL_MAX`` |
Changing |
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.
Marking as changes requested, re: #101319 (comment)
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
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.
Looks good now, and the warnings fixed 👍
https://deploy-preview-101319--python-cpython-preview.netlify.app/library/sys.html#sys.float_info
Thanks!
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.
Actually, one last little thing :)
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Thanks @furkanonder for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11. |
Thank you! |
Sorry, @furkanonder and @hugovk, I could not cleanly backport this to |
Sorry @furkanonder and @hugovk, I had trouble checking out the |
) Co-authored-by: Hugo van Kemenade <[email protected]>
GH-102321 is a backport of this pull request to the 3.11 branch. |
) Co-authored-by: Hugo van Kemenade <[email protected]>
GH-102322 is a backport of this pull request to the 3.10 branch. |
The backports also include GH-99675 to avoid conflict, and which wasn't originally backported. |
* main: (67 commits) pythongh-99108: Add missing md5/sha1 defines to Modules/Setup (python#102308) pythongh-100227: Move _str_replace_inf to PyInterpreterState (pythongh-102333) pythongh-100227: Move the dtoa State to PyInterpreterState (pythongh-102331) pythonGH-102305: Expand some macros in generated_cases.c.h (python#102309) Migrate to new PSF mailgun account (python#102284) pythongh-102192: Replace PyErr_Fetch/Restore etc by more efficient alternatives (in Python/) (python#102193) pythonGH-90744: Fix erroneous doc links in the sys module (python#101319) pythongh-87092: Make jump target label equal to the offset of the target in the instructions sequence (python#102093) pythongh-101101: Unstable C API tier (PEP 689) (pythonGH-101102) IDLE: Simplify DynOptionsMenu __init__code (python#101371) pythongh-101561: Add typing.override decorator (python#101564) pythongh-101825: Clarify that as_integer_ratio() output is always normalized (python#101843) pythongh-101773: Optimize creation of Fractions in private methods (python#101780) pythongh-102251: Updates to test_imp Toward Fixing Some Refleaks (pythongh-102254) pythongh-102296 Document that inspect.Parameter kinds support ordering (pythonGH-102297) pythongh-102250: Fix double-decref in COMPARE_AND_BRANCH error case (pythonGH-102287) pythongh-101100: Fix sphinx warnings in `types` module (python#102274) pythongh-91038: Change default argument value to `False` instead of `0` (python#31621) pythongh-101765: unicodeobject: use Py_XDECREF correctly (python#102283) [doc] Improve grammar/fix missing word (pythonGH-102060) ...
#102321) Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Brad Wolfe <[email protected]> Co-authored-by: Furkan Onder <[email protected]> Fix erroneous doc links in the sys module (#101319)
#102322) Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Brad Wolfe <[email protected]> Co-authored-by: Furkan Onder <[email protected]> Fix erroneous doc links in the sys module (#101319)