Skip to content

documentation for http.server refers to wrong test() function #97822

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed
yedpodtrzitko opened this issue Oct 4, 2022 · 4 comments
Closed

documentation for http.server refers to wrong test() function #97822

yedpodtrzitko opened this issue Oct 4, 2022 · 4 comments
Labels
docs Documentation in the Doc dir easy

Comments

@yedpodtrzitko
Copy link

Documentation

the following paragraph in docs for http.server mentions function test:

For example usage, see the implementation of the :func:`test` function
invocation in the :mod:`http.server` module.

which is a reference to function test in the same file:

def test(HandlerClass=BaseHTTPRequestHandler,

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.

@yedpodtrzitko yedpodtrzitko added the docs Documentation in the Doc dir label Oct 4, 2022
@orsenthil
Copy link
Member

Could open a pull request to fix this?

@orsenthil orsenthil added the easy label Oct 4, 2022
@yedpodtrzitko
Copy link
Author

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?

@davidism
Copy link

davidism commented Oct 4, 2022

List the full path to the name, it will be a link with the text http.server.test:

For example, see the implementation of the :func:`http.server.test` function.

Alternatively, add a ~ at the front, and it will remain in the current format, showing only the test name.

For example, see the implementation of the :func:`~http.server.test` function in the :mod:`http.server` module. 

Jason-Y-Z added a commit to Jason-Y-Z/cpython that referenced this issue Oct 7, 2022
Jason-Y-Z added a commit to Jason-Y-Z/cpython that referenced this issue Oct 7, 2022
Jason-Y-Z added a commit to Jason-Y-Z/cpython that referenced this issue Oct 7, 2022
Jason-Y-Z added a commit to Jason-Y-Z/cpython that referenced this issue Oct 7, 2022
JelleZijlstra added a commit to Jason-Y-Z/cpython that referenced this issue Oct 7, 2022
JelleZijlstra added a commit that referenced this issue Oct 8, 2022
…98027)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 8, 2022
…ction (pythonGH-98027)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 6b48562)

Co-authored-by: JasonYZ <yurenzhang2017@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 8, 2022
…ction (pythonGH-98027)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 6b48562)

Co-authored-by: JasonYZ <yurenzhang2017@gmail.com>
miss-islington added a commit that referenced this issue Oct 8, 2022
…H-98027)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 6b48562)

Co-authored-by: JasonYZ <yurenzhang2017@gmail.com>
miss-islington added a commit that referenced this issue Oct 8, 2022
…H-98027)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 6b48562)

Co-authored-by: JasonYZ <yurenzhang2017@gmail.com>
carljm added a commit to carljm/cpython that referenced this issue Oct 8, 2022
* 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)
@hauntsaninja
Copy link
Contributor

Looks like this is fixed and all backports are merged. Thank you!

carljm added a commit to carljm/cpython that referenced this issue Oct 9, 2022
* 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 issue Oct 11, 2022
…ction (python#98027)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
…H-98027)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 6b48562)

Co-authored-by: JasonYZ <yurenzhang2017@gmail.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
docs Documentation in the Doc dir easy
Projects
None yet
Development

No branches or pull requests

4 participants