-
-
Notifications
You must be signed in to change notification settings - Fork 30.8k
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
documentation for http.server
refers to wrong test()
function
#97822
Comments
Could open a pull request to fix this? |
sure, I just dont know what's the recommended way how to refer to a specific function in the code - do I use link with the latest commit or is it preferred some other way? |
List the full path to the name, it will be a link with the text For example, see the implementation of the :func:`http.server.test` function. Alternatively, add a For example, see the implementation of the :func:`~http.server.test` function in the :mod:`http.server` module. |
…98027) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
…ction (pythonGH-98027) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 6b48562) Co-authored-by: JasonYZ <yurenzhang2017@gmail.com>
…ction (pythonGH-98027) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 6b48562) Co-authored-by: JasonYZ <yurenzhang2017@gmail.com>
* 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)
Looks like this is fixed and all backports are merged. Thank you! |
* 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) ...
…ction (python#98027) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Documentation
the following paragraph in docs for
http.server
mentions functiontest
:cpython/Doc/library/http.server.rst
Lines 395 to 396 in e3b6ff1
which is a reference to function
test
in the same file:cpython/Lib/http/server.py
Line 1239 in 9a95fa9
but in the rendered docs
:func:`test`
is resolved as a link to https://docs.python.org/3/library/test.html#module-test instead of the aforementioned function in the same file.The text was updated successfully, but these errors were encountered: