gh-97822: Fix http.server documentation reference to test() function#98027

Jason-Y-Z · 2022-10-07T12:54:51Z

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

ghost · 2022-10-07T12:55:21Z

All commit authors signed the Contributor License Agreement.

JelleZijlstra · 2022-10-07T15:14:40Z

Doc/library/http.server.rst

 ``text/`` the file is opened in text mode; otherwise binary mode is used.

- For example usage, see the implementation of the :func:`test` function
+ For example usage, see the implementation of the :func:`~http.server.test` function


This link won't work, because the test() function is (rightly) not documented. I think it would be more helpful to link to the source code, which can be done with the :source: directive.

Thanks for the review, hopefully the latest version fixed this :)

JelleZijlstra · 2022-10-07T16:52:44Z

Doc/library/http.server.rst

 ``text/`` the file is opened in text mode; otherwise binary mode is used.

- For example usage, see the implementation of the :func:`test` function
+ For example usage, see the implementation of the :source:`~http.server.test` function


This is not correct, you need a file path like Lib/http/server.py. See the top of https://docs.python.org/3.10/library/dbm.html for an example of how it is rendered.

Right, thanks for your help :)

JelleZijlstra · 2022-10-07T16:53:08Z

Doc/library/http.server.rst

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


Suggested change
For example usage, see the implementation of the :source:`~http.server.test` function
invocation in the :mod:`http.server` module.
For example usage, see the implementation of the ``test`` function
invocation in :source:`Lib/http/server.py`.

Doc/library/http.server.rst

…ction

Jason-Y-Z · 2022-10-07T19:23:18Z

I might be wrong, but the build error message seems to be suggesting something else broken?

JelleZijlstra · 2022-10-07T20:31:29Z

Sorry for that, #98056 will fix it.

Doc/library/http.server.rst

miss-islington · 2022-10-08T04:46:26Z

Thanks @Jason-Y-Z for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

bedevere-bot · 2022-10-08T04:46:42Z

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

…ction (pythonGH-98027) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 6b48562) Co-authored-by: JasonYZ <yurenzhang2017@gmail.com>

bedevere-bot · 2022-10-08T04:46:47Z

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

…ction (pythonGH-98027) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 6b48562) Co-authored-by: JasonYZ <yurenzhang2017@gmail.com>

…H-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)

* 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>

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

bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 7, 2022

JelleZijlstra reviewed Oct 7, 2022
View reviewed changes

Jason-Y-Z force-pushed the gh-97822 branch from 0355123 to 9d4a36bCompare October 7, 2022 16:01

JelleZijlstra reviewed Oct 7, 2022
View reviewed changes

Jason-Y-Z force-pushed the gh-97822 branch from 9d4a36b to d57649fCompare October 7, 2022 18:58

JelleZijlstra reviewed Oct 7, 2022
View reviewed changes

Doc/library/http.server.rst Outdated Show resolvedHide resolved

JelleZijlstra approved these changes Oct 7, 2022
View reviewed changes

bedevere-bot added awaiting merge and removed awaiting review labels Oct 7, 2022

JelleZijlstra self-assigned this Oct 7, 2022

pythongh-97822: Fix http.server documentation reference to test() fun…
0682fbd
…ction

Jason-Y-Z force-pushed the gh-97822 branch from b44ed69 to 0682fbdCompare October 7, 2022 19:02

Merge branch 'main' intopythongh-97822
97790bf

JelleZijlstra reviewed Oct 8, 2022
View reviewed changes

Doc/library/http.server.rst Outdated Show resolvedHide resolved

Update Doc/library/http.server.rst
d6fe4ce

JelleZijlstra added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Oct 8, 2022

JelleZijlstra merged commit 6b48562 into python:mainOct 8, 2022

bedevere-bot removed the awaiting merge label Oct 8, 2022

bedevere-bot removed the needs backport to 3.11 only security fixes label Oct 8, 2022

bedevere-bot removed the needs backport to 3.10 only security fixes label Oct 8, 2022

Jason-Y-Z deleted the gh-97822 branch October 8, 2022 08:33

mpage pushed a commit to mpage/cpython that referenced this pull request Oct 11, 2022
pythongh-97822: Fix http.server documentation reference to test() fun…
e20a190
…ction (python#98027) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

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

Uh oh!

gh-97822: Fix http.server documentation reference to test() function#98027

gh-97822: Fix http.server documentation reference to test() function #98027

Uh oh!

Conversation

Jason-Y-Z commented Oct 7, 2022• edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Oct 7, 2022• edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JelleZijlstraOct 7, 2022

Choose a reason for hiding this comment

Uh oh!

Jason-Y-ZOct 7, 2022

Choose a reason for hiding this comment

Uh oh!

JelleZijlstraOct 7, 2022

Choose a reason for hiding this comment

Uh oh!

Jason-Y-ZOct 7, 2022

Choose a reason for hiding this comment

Uh oh!

JelleZijlstraOct 7, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Jason-Y-Z commented Oct 7, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JelleZijlstra commented Oct 7, 2022

Uh oh!

Uh oh!

miss-islington commented Oct 8, 2022

Uh oh!

bedevere-bot commented Oct 8, 2022

Uh oh!

bedevere-bot commented Oct 8, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Jason-Y-Z commented Oct 7, 2022•
edited by bedevere-bot
Loading

ghost commented Oct 7, 2022•
edited by ghost
Loading

Jason-Y-Z commented Oct 7, 2022•
edited
Loading