FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-97822: Fix http.server documentation reference to test() function by Jason-Y-Z · Pull Request #98027 · python/cpython · GitHub

/ cpython Public

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

Merged
JelleZijlstra merged 3 commits into
python:mainfrom
Jason-Y-Z:gh-97822
Oct 8, 2022
ConversationCommits (3)ChecksFiles changed
Merged

gh-97822: Fix http.server documentation reference to test() function#98027
JelleZijlstra merged 3 commits into
python:mainfrom
Jason-Y-Z:gh-97822

Conversation

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

Copy link
Copy Markdown
Contributor

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

ghost commented Oct 7, 2022 •
edited by ghost
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

JelleZijlstra reviewed Oct 7, 2022
View reviewed changes
Comment thread Doc/library/http.server.rst Outdated
``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

JelleZijlstra Oct 7, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

Jason-Y-Z Oct 7, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

JelleZijlstra reviewed Oct 7, 2022
View reviewed changes
Comment thread Doc/library/http.server.rst Outdated
``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

JelleZijlstra Oct 7, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

Jason-Y-Z Oct 7, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Right, thanks for your help :)

JelleZijlstra reviewed Oct 7, 2022
View reviewed changes
Comment thread Doc/library/http.server.rst Outdated
Comment on lines 395 to 396
For example usage, see the implementation of the :source:`~http.server.test` function
invocation in the :mod:`http.server` module.

JelleZijlstra Oct 7, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality
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`.

JelleZijlstra reviewed Oct 7, 2022
View reviewed changes
Comment thread Doc/library/http.server.rst Outdated
JelleZijlstra self-assigned this Oct 7, 2022

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

Copy link
Copy Markdown
Contributor Author

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

JelleZijlstra commented Oct 7, 2022

Copy link
Copy Markdown
Member

Sorry for that, #98056 will fix it.

JelleZijlstra reviewed Oct 8, 2022
View reviewed changes
Comment thread Doc/library/http.server.rst Outdated
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:main Oct 8, 2022

miss-islington commented Oct 8, 2022

Copy link
Copy Markdown
Contributor

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 commented Oct 8, 2022

Copy link
Copy Markdown

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

bedevere-bot removed the needs backport to 3.11 only security fixes label Oct 8, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 8, 2022
pythongh-97822: Fix http.server documentation reference to test() fun…
1676696 
…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 commented Oct 8, 2022

Copy link
Copy Markdown

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

bedevere-bot removed the needs backport to 3.10 only security fixes label Oct 8, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 8, 2022
pythongh-97822: Fix http.server documentation reference to test() fun…
5442004 
…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 pull request Oct 8, 2022
gh-97822: Fix http.server documentation reference to test() function (G…
b5196fa 
…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 pull request Oct 8, 2022
gh-97822: Fix http.server documentation reference to test() function (G…
786fde5 
…H-98027)

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

Co-authored-by: JasonYZ <yurenzhang2017@gmail.com>
Jason-Y-Z deleted the gh-97822 branch October 8, 2022 08:33
carljm added a commit to carljm/cpython that referenced this pull request Oct 8, 2022
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
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
pythongh-97822: Fix http.server documentation reference to test() fun…
e20a190 
…ction (python#98027)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
gh-97822: Fix http.server documentation reference to test() function (G…
dfae46c 
…H-98027)

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

Co-authored-by: JasonYZ <yurenzhang2017@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

JelleZijlstra JelleZijlstra approved these changes

Assignees

JelleZijlstra

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL