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 — DOC: fix broken links to modules by partev · Pull Request #96914 · python/cpython

Conversation

@partev

@partev partev commented Sep 18, 2022 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Contributor

fix 3 broken links to modules: random, ctypes, and decimal.

https://docs.python.org/3.12/license.html#mersenne-twister

https://docs.python.org/3.12/license.html#libffi

https://docs.python.org/3.12/license.html#libmpdec

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@partev
DOC: fix broken links to modules
e7e0126
@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Sep 18, 2022
@slateny

slateny commented Sep 19, 2022

Copy link
Copy Markdown
Contributor

By modules, I believe it refers to the C modules under Modules, not the Python ones under Lib. For example, the comments in _randommodule.c match up with what's listed in the license file.
All reactions

Sorry, something went wrong.

Uh oh!

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

partev commented Sep 19, 2022 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Contributor Author

By modules, I believe it refers to the C modules under Modules, not the Python ones under Lib. For example, the comments in _randommodule.c match up with what's listed in the license file.

sounds plausible. Should :mod: keyword be removed then?
All reactions

Sorry, something went wrong.

Uh oh!

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

slateny commented Sep 20, 2022

Copy link
Copy Markdown
Contributor

Actually a correction - ctypes doesn't have a module under Lib so the change would make sense. As for keeping or changing _random/_decimal, I'm not too confident on that part but I feel that it should just be kept as it is now.

@CAM-Gerlach Could you double check my thoughts here?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
CAM-Gerlach
CAM-Gerlach reviewed Sep 22, 2022
View reviewed changes

@CAM-Gerlach CAM-Gerlach 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.

Sorry for the delay, You can prefix a reference name with ! to not resolve the reference, and just format the contents with the appropriate styling, i.e. :mod:`!_random` to mention the extension module, formatted as a module but without trying to resolve the reference, and you can also use a different display name as the actual resolved reference, i.e. `` :mod:_random <random> to specifically refer to the `_random` extension module while referring to the overall documentation for the `random` module.

However, given the evident confusion here over the ambiguity between a Python "module" and the C extension modules in the CPython Modules directory, and the need for clarity as far as licensing is concerned, I suggest specifically separating the two, as my GitHub suggestions illustrate, which link to the name/documentation for the overall module, but also make clear that the specific code the license refers to is the _-prefixed C extension module component.

I played around with several other words to describe the relationship other than "underlying", including "supporting", "for", "of", etc. and am not sure what people would like best here, but left it for now.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/license.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/license.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/license.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@CAM-Gerlach

CAM-Gerlach commented Sep 22, 2022 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Member

Actually a correction - ctypes doesn't have a module under Lib so the change would make sense. As for keeping or changing _random/_decimal, I'm not too confident on that part but I feel that it should just be kept as it is now.

Actually, it has a whole package under Lib.
slateny reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@CAM-Gerlach CAM-Gerlach added the skip issue label Sep 22, 2022
ambv and others added 3 commits October 7, 2022 13:55
@ambv @CAM-Gerlach
Apply CAM's suggestions
2144f60 
Co-authored-by: C.A.M. Gerlach <[email protected]>
@ambv
Merge branch 'main' into patch-12
f8141c4
@ambv
Merge branch 'main' into patch-12
99a10d7
@ambv
ambv merged commit 840fd19 into python:main Oct 8, 2022
@bedevere-bot bedevere-bot removed the awaiting review label Oct 8, 2022
@partev
partev deleted the patch-12 branch October 8, 2022 13:32
carljm added a commit to carljm/cpython that referenced this pull request Oct 8, 2022
@carljm
Merge branch 'main' into typewatch
d67d6fd 
* main:
  pythongh-68686: Retire eptag ptag scripts (python#98064)
  pythongh-97922: Run the GC only on eval breaker (python#97920)
  GitHub Workflows security hardening (python#96492)
  Add `@ezio-melotti` as codeowner for `.github/`. (python#98079)
  pythongh-97913 Docs: Add walrus operator to the index (python#97921)
  [doc] Fix broken links to C extensions accelerating stdlib modules (python#96914)
  pythongh-97822: Fix http.server documentation reference to test() function (python#98027)
  pythongh-91052: Add PyDict_Unwatch for unwatching a dictionary (python#98055)
  pythonGH-98023: Change default child watcher to PidfdChildWatcher on supported systems (python#98024)
  pythonGH-94182: Run the PidfdChildWatcher on the running loop (python#94184)
carljm added a commit to carljm/cpython that referenced this pull request Oct 9, 2022
@carljm
Merge branch 'main' into urllibnonet
132c32e 
* main: (5519 commits)
  Minor edits to the Descriptor HowTo Guide (pythonGH-24901)
  Fix link to Lifecycle of a Pull Request in CONTRIBUTING (python#98102)
  pythonGH-94597: deprecate `SafeChildWatcher`, `FastChildWatcher` and `MultiLoopChildWatcher` child watchers  (python#98089)
  Auto-cancel old builds when new commit pushed to branch (python#98009)
  pythongh-95011: Migrate syslog module to Argument Clinic (pythonGH-95012)
  pythongh-68686: Retire eptag ptag scripts (python#98064)
  pythongh-97922: Run the GC only on eval breaker (python#97920)
  GitHub Workflows security hardening (python#96492)
  Add `@ezio-melotti` as codeowner for `.github/`. (python#98079)
  pythongh-97913 Docs: Add walrus operator to the index (python#97921)
  [doc] Fix broken links to C extensions accelerating stdlib modules (python#96914)
  pythongh-97822: Fix http.server documentation reference to test() function (python#98027)
  pythongh-91052: Add PyDict_Unwatch for unwatching a dictionary (python#98055)
  pythonGH-98023: Change default child watcher to PidfdChildWatcher on supported systems (python#98024)
  pythonGH-94182: Run the PidfdChildWatcher on the running loop (python#94184)
  pythongh-92886: make test_ast pass with -O (assertions off) (pythonGH-98058)
  pythongh-92886: make test_coroutines pass with -O (assertions off) (pythonGH-98060)
  pythongh-57179: Add note on symlinks for os.walk (python#94799)
  pythongh-94808: Fix regex on exotic platforms (python#98036)
  pythongh-90085: Remove vestigial -t and -c timeit options (python#94941)
  ...
mpage pushed a commit to mpage/cpython that referenced this pull request Oct 11, 2022
@partev @ambv
@CAM-Gerlach @mpage
[doc] Fix broken links to C extensions accelerating stdlib modules (p…
98b3aca 
…ython#96914)

Co-authored-by: Łukasz Langa <[email protected]>
Co-authored-by: C.A.M. Gerlach <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@CAM-Gerlach CAM-Gerlach CAM-Gerlach left review comments

Uh oh!

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

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue 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

@partev @slateny @CAM-Gerlach @ambv @bedevere-bot
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.