GH-90744: Fix erroneous doc links in the sys module #101319

furkanonder · 2023-01-25T14:58:43Z

Issue: In documentation same-named attributes erroneously link to built-in names #90744

hugovk · 2023-01-26T16:07:34Z

This removes the bad links, but they're no longer formatted as code:

Before	After

https://docs.python.org/3.12/library/sys.html#sys.float_info	https://deploy-preview-101319--python-cpython-preview.netlify.app/library/sys.html#sys.float_info

And when running Sphinx in nit-picky mode (re: #101100), we're getting warnings about all of those:

Doc/library/sys.rst:14: WARNING: py:const reference target not found: epsilon
Doc/library/sys.rst:19: WARNING: py:const reference target not found: dig
Doc/library/sys.rst:22: WARNING: py:const reference target not found: mant_dig
Doc/library/sys.rst:27: WARNING: py:const reference target not found: max_exp
Doc/library/sys.rst:30: WARNING: py:const reference target not found: max_10_exp
Doc/library/sys.rst:39: WARNING: py:const reference target not found: min_exp
Doc/library/sys.rst:42: WARNING: py:const reference target not found: min_10_exp
Doc/library/sys.rst:45: WARNING: py:const reference target not found: radix
Doc/library/sys.rst:47: WARNING: py:const reference target not found: rounds

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``

furkanonder · 2023-02-01T10:10:07Z

This removes the bad links, but they're no longer formatted as code:

Before After

https://docs.python.org/3.12/library/sys.html#sys.float_info https://deploy-preview-101319--python-cpython-preview.netlify.app/library/sys.html#sys.float_info
And when running Sphinx in nit-picky mode (re: #101100), we're getting warnings about all of those:
Doc/library/sys.rst:14: WARNING: py:const reference target not found: epsilon
Doc/library/sys.rst:19: WARNING: py:const reference target not found: dig
Doc/library/sys.rst:22: WARNING: py:const reference target not found: mant_dig
Doc/library/sys.rst:27: WARNING: py:const reference target not found: max_exp
Doc/library/sys.rst:30: WARNING: py:const reference target not found: max_10_exp
Doc/library/sys.rst:39: WARNING: py:const reference target not found: min_exp
Doc/library/sys.rst:42: WARNING: py:const reference target not found: min_10_exp
Doc/library/sys.rst:45: WARNING: py:const reference target not found: radix
Doc/library/sys.rst:47: WARNING: py:const reference target not found: rounds
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 :const:`max` to ``max`` made sense to me. The gray background behind the texts, in my opinion, makes the words stand out more. We can also make these corrections for other words in the documents.

hugovk

Marking as changes requested, re: #101319 (comment)

bedevere-bot · 2023-02-21T12:52:36Z

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 I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

hugovk

Looks good now, and the warnings fixed 👍

https://deploy-preview-101319--python-cpython-preview.netlify.app/library/sys.html#sys.float_info

Thanks!

hugovk

Actually, one last little thing :)

Doc/library/sys.rst

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

miss-islington · 2023-02-28T11:43:04Z

Thanks @furkanonder for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

hugovk · 2023-02-28T11:43:06Z

Thank you!

miss-islington · 2023-02-28T11:43:09Z

Sorry, @furkanonder and @hugovk, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 85b1fc1fc5a2e49d521382eaf5e7793175d00371 3.11

miss-islington · 2023-02-28T11:43:15Z

Sorry @furkanonder and @hugovk, I had trouble checking out the 3.10 backport branch.
Please retry by removing and re-adding the "needs backport to 3.10" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker 85b1fc1fc5a2e49d521382eaf5e7793175d00371 3.10

) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

bedevere-bot · 2023-02-28T11:53:52Z

GH-102321 is a backport of this pull request to the 3.11 branch.

) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

bedevere-bot · 2023-02-28T12:06:15Z

GH-102322 is a backport of this pull request to the 3.10 branch.

hugovk · 2023-02-28T12:07:09Z

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 <hugovk@users.noreply.github.com> Co-authored-by: Brad Wolfe <brad.wolfe@gmail.com> Co-authored-by: Furkan Onder <furkanonder@protonmail.com> Fix erroneous doc links in the sys module (#101319)

#102322) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Brad Wolfe <brad.wolfe@gmail.com> Co-authored-by: Furkan Onder <furkanonder@protonmail.com> Fix erroneous doc links in the sys module (#101319)

Fix erroneous doc links in the sys module

cc18fe7

bedevere-bot added the awaiting review label Jan 25, 2023

bedevere-bot mentioned this pull request Jan 25, 2023

In documentation same-named attributes erroneously link to built-in names #90744

Closed

bedevere-bot added docs Documentation in the Doc dir skip news labels Jan 25, 2023

Merge branch 'main' into issue-90744

cc32234

merwok added the DO-NOT-MERGE label Feb 13, 2023

hugovk requested changes Feb 21, 2023

View reviewed changes

bedevere-bot added awaiting changes and removed awaiting review labels Feb 21, 2023

furkanonder added 2 commits February 27, 2023 02:12

Fix erroneous doc links in the sys module

c7c468b

Merge branch 'main' into issue-90744

a565118

furkanonder requested a review from hugovk February 26, 2023 23:25

hugovk approved these changes Feb 27, 2023

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting changes labels Feb 27, 2023

hugovk added DO-NOT-MERGE needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes and removed DO-NOT-MERGE labels Feb 27, 2023

hugovk reviewed Feb 27, 2023

View reviewed changes

Doc/library/sys.rst Outdated Show resolved Hide resolved

Doc/library/sys.rst Outdated Show resolved Hide resolved

furkanonder and others added 2 commits February 28, 2023 13:04

Update Doc/library/sys.rst

63d0f3b

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Update Doc/library/sys.rst

5151e4a

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

hugovk removed the DO-NOT-MERGE label Feb 28, 2023

hugovk merged commit 85b1fc1 into python:main Feb 28, 2023

bedevere-bot removed the awaiting merge label Feb 28, 2023

miss-islington assigned hugovk Feb 28, 2023

hugovk added a commit to hugovk/cpython that referenced this pull request Feb 28, 2023

pythonGH-90744: Fix erroneous doc links in the sys module (python#101319

5199c40

) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

hugovk mentioned this pull request Feb 28, 2023

[3.11] gh-90744: Fix erroneous doc links in the sys module (GH-101319) #102321

Merged

bedevere-bot removed the needs backport to 3.11 only security fixes label Feb 28, 2023

hugovk added a commit to hugovk/cpython that referenced this pull request Feb 28, 2023

pythonGH-90744: Fix erroneous doc links in the sys module (python#101319

a0fb9b3

) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

hugovk mentioned this pull request Feb 28, 2023

[3.10] gh-90744: Fix erroneous doc links in the sys module (GH-101319) #102322

Merged

bedevere-bot removed the needs backport to 3.10 only security fixes label Feb 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GH-90744: Fix erroneous doc links in the sys module #101319

GH-90744: Fix erroneous doc links in the sys module #101319

furkanonder commented Jan 25, 2023 •

edited by bedevere-bot

Loading

hugovk commented Jan 26, 2023

furkanonder commented Feb 1, 2023

hugovk left a comment

bedevere-bot commented Feb 21, 2023

hugovk left a comment

hugovk left a comment

miss-islington commented Feb 28, 2023

hugovk commented Feb 28, 2023

miss-islington commented Feb 28, 2023

miss-islington commented Feb 28, 2023

bedevere-bot commented Feb 28, 2023

bedevere-bot commented Feb 28, 2023

hugovk commented Feb 28, 2023

GH-90744: Fix erroneous doc links in the sys module #101319

GH-90744: Fix erroneous doc links in the sys module #101319

Conversation

furkanonder commented Jan 25, 2023 • edited by bedevere-bot Loading

hugovk commented Jan 26, 2023

furkanonder commented Feb 1, 2023

hugovk left a comment

Choose a reason for hiding this comment

bedevere-bot commented Feb 21, 2023

hugovk left a comment

Choose a reason for hiding this comment

hugovk left a comment

Choose a reason for hiding this comment

miss-islington commented Feb 28, 2023

hugovk commented Feb 28, 2023

miss-islington commented Feb 28, 2023

miss-islington commented Feb 28, 2023

bedevere-bot commented Feb 28, 2023

bedevere-bot commented Feb 28, 2023

hugovk commented Feb 28, 2023

furkanonder commented Jan 25, 2023 •

edited by bedevere-bot

Loading