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 — GH-90744: Fix erroneous doc links in the sys module by furkanonder · Pull Request #101319 · python/cpython

Conversation

@furkanonder

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

Uh oh!

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

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

Sorry, something went wrong.

Uh oh!

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

All reactions
@furkanonder
Fix erroneous doc links in the sys module
cc18fe7
@bedevere-bot bedevere-bot added the awaiting review label Jan 25, 2023
@bedevere-bot bedevere-bot mentioned this pull request Jan 25, 2023
In documentation same-named attributes erroneously link to built-in names #90744
Closed
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news labels Jan 25, 2023
@furkanonder
Merge branch 'main' into issue-90744
cc32234
@hugovk

hugovk commented Jan 26, 2023

Copy link
Copy Markdown
Member

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

Before After
image image
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``
CAM-Gerlach and AlexWaygood reacted with thumbs up emoji
All reactions
  • 👍 2 reactions

Sorry, something went wrong.

Uh oh!

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

@furkanonder

furkanonder commented Feb 1, 2023

Copy link
Copy Markdown
Contributor Author

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

Before After
image image
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.

All reactions

Sorry, something went wrong.

Uh oh!

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

@merwok merwok added the DO-NOT-MERGE label Feb 13, 2023
hugovk
hugovk requested changes Feb 21, 2023
View reviewed changes

@hugovk hugovk 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.

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

Sorry, something went wrong.

Uh oh!

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

CAM-Gerlach and furkanonder reacted with thumbs up emoji
All reactions
  • 👍 2 reactions
@bedevere-bot bedevere-bot added awaiting changes and removed awaiting review labels Feb 21, 2023
@bedevere-bot

bedevere-bot commented Feb 21, 2023

Copy link
Copy Markdown

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.

All reactions

Sorry, something went wrong.

Uh oh!

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

furkanonder added 2 commits February 27, 2023 02:12
@furkanonder
Fix erroneous doc links in the sys module
c7c468b
@furkanonder
Merge branch 'main' into issue-90744
a565118
@furkanonder
furkanonder requested a review from hugovk February 26, 2023 23:25
hugovk
hugovk approved these changes Feb 27, 2023
View reviewed changes

@hugovk hugovk 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.

Looks good now, and the warnings fixed 👍

image

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

Thanks!

Sorry, something went wrong.

Uh oh!

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

All reactions
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting changes labels Feb 27, 2023
@hugovk hugovk added DO-NOT-MERGE needs backport to 3.10 needs backport to 3.11 only security fixes and removed DO-NOT-MERGE labels Feb 27, 2023
hugovk
hugovk reviewed Feb 27, 2023
View reviewed changes

@hugovk hugovk 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.

Actually, one last little thing :)

Sorry, something went wrong.

Uh oh!

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

furkanonder reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
Comment thread Doc/library/sys.rst Resolved

Uh oh!

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

Comment thread Doc/library/sys.rst Resolved

Uh oh!

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

furkanonder and others added 2 commits February 28, 2023 13:04
@furkanonder @hugovk
Update Doc/library/sys.rst
63d0f3b
Co-authored-by: Hugo van Kemenade <[email protected]>
@furkanonder @hugovk
Update Doc/library/sys.rst
5151e4a
Co-authored-by: Hugo van Kemenade <[email protected]>
@hugovk hugovk removed the DO-NOT-MERGE label Feb 28, 2023
@hugovk
hugovk merged commit 85b1fc1 into python:main Feb 28, 2023
@miss-islington

miss-islington commented Feb 28, 2023

Copy link
Copy Markdown
Contributor

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

All reactions

Sorry, something went wrong.

Uh oh!

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

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

hugovk commented Feb 28, 2023

Copy link
Copy Markdown
Member

Thank you!

All reactions

Sorry, something went wrong.

Uh oh!

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

@miss-islington

miss-islington commented Feb 28, 2023

Copy link
Copy Markdown
Contributor

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

All reactions

Sorry, something went wrong.

Uh oh!

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

@miss-islington miss-islington assigned hugovk Feb 28, 2023
@miss-islington

miss-islington commented Feb 28, 2023

Copy link
Copy Markdown
Contributor

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

All reactions

Sorry, something went wrong.

Uh oh!

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

hugovk added a commit to hugovk/cpython that referenced this pull request Feb 28, 2023
@furkanonder @hugovk
pythonGH-90744: Fix erroneous doc links in the sys module (python#101319
5199c40
)

Co-authored-by: Hugo van Kemenade <[email protected]>
@hugovk 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

bedevere-bot commented Feb 28, 2023

Copy link
Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

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

@bedevere-bot 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
@furkanonder @hugovk
pythonGH-90744: Fix erroneous doc links in the sys module (python#101319
a0fb9b3
)

Co-authored-by: Hugo van Kemenade <[email protected]>
@hugovk 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

bedevere-bot commented Feb 28, 2023

Copy link
Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

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

@bedevere-bot bedevere-bot removed the needs backport to 3.10 label Feb 28, 2023
@hugovk

hugovk commented Feb 28, 2023

Copy link
Copy Markdown
Member

The backports also include GH-99675 to avoid conflict, and which wasn't originally backported.

All reactions

Sorry, something went wrong.

Uh oh!

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

carljm added a commit to carljm/cpython that referenced this pull request Feb 28, 2023
@carljm
Merge branch 'main' into inlinecomp2
73dc0ed
* 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)
  ...
hugovk added a commit that referenced this pull request Mar 2, 2023
@hugovk @tbwolfe @furkanonder
[3.11] gh-90744: Fix erroneous doc links in the sys module (GH-101319) (
9a5f2e8
#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)
hugovk added a commit that referenced this pull request Mar 2, 2023
@hugovk @tbwolfe @furkanonder
[3.10] gh-90744: Fix erroneous doc links in the sys module (GH-101319) (
a8f9a82
#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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk approved these changes

Uh oh!

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

Assignees

@hugovk hugovk

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.

Uh oh!

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

5 participants

@furkanonder @hugovk @bedevere-bot @miss-islington @merwok
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.