DOC: fix broken links to modules #96914
Conversation
|
By modules, I believe it refers to the C modules under |
sounds plausible. Should :mod: keyword be removed then? |
|
Actually a correction - @CAM-Gerlach Could you double check my thoughts here? |
There was a problem hiding this comment.
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.
Actually, it has a whole package under |
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* 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)
* 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) ...
…ython#96914) Co-authored-by: Łukasz Langa <lukasz@langa.pl> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
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