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

gh-130160: use `.. program::` directive for documenting `http.server` CLI by donbarbos · Pull Request #131010 · python/cpython · GitHub

/ cpython Public

gh-130160: use .. program:: directive for documenting http.server CLI - #131010

Merged
hugovk merged 5 commits into
python:mainfrom
donbarbos:issue-130160-httpserver
Mar 15, 2025
ConversationCommits (5)ChecksFiles changed
Merged

gh-130160: use .. program:: directive for documenting http.server CLI#131010
hugovk merged 5 commits into
python:mainfrom
donbarbos:issue-130160-httpserver

Conversation

donbarbos commented Mar 9, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

I wasn't sure if I should move the --cgi flag to this section as it is already deprecated and will be removed in 3.15
It is currently located below CGIHTTPRequestHandler class description

main branch PR branch

📚 Documentation preview 📚: https://cpython-previews--131010.org.readthedocs.build/

bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels Mar 9, 2025
github-project-automation Bot moved this to Todo in Docs PRs Mar 9, 2025
bedevere-app Bot mentioned this pull request Mar 9, 2025
Closed
6 tasks

picnixz commented Mar 9, 2025

Copy link
Copy Markdown
Member

Even if the flag is deprecated and planned for removal it's better to document as such. For the CLI rendering we can also just have python -m http.server [OPTIONS] and list the options afterwards with some "The allowed options are listed below." introductory sentence.

picnixz added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Mar 9, 2025

picnixz commented Mar 9, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

Note that 3.13 is still a stable release and deprecated features are still legitimate to use

donbarbos commented Mar 10, 2025

Copy link
Copy Markdown
Contributor Author

Section was updated:

picnixz commented Mar 10, 2025

Copy link
Copy Markdown
Member

I'll review it at home

picnixz self-requested a review March 13, 2025 17:08
picnixz reviewed Mar 15, 2025
View reviewed changes
Comment thread Doc/library/http.server.rst Outdated
Comment thread Doc/library/http.server.rst Outdated
picnixz approved these changes Mar 15, 2025
View reviewed changes

picnixz left a comment

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

LGTM.

picnixz requested a review from hugovk March 15, 2025 12:38
hugovk approved these changes Mar 15, 2025
View reviewed changes

hugovk left a comment

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

Thanks!

Comment thread Doc/library/http.server.rst Outdated
Comment thread Doc/library/http.server.rst Outdated

donbarbos commented Mar 15, 2025

Copy link
Copy Markdown
Contributor Author

Thank you for review

hugovk merged commit 7ae9c5d into python:main Mar 15, 2025
github-project-automation Bot moved this from Todo to Done in Docs PRs Mar 15, 2025

miss-islington-app Bot commented Mar 15, 2025

Copy link
Copy Markdown

Thanks @donbarbos for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 15, 2025
pythongh-130160: use .. program:: directive for documenting `http.s…
0b6c6f4 
…erver` CLI (pythonGH-131010)

(cherry picked from commit 7ae9c5d)

Co-authored-by: donBarbos <donbarbos@proton.me>

miss-islington-app Bot commented Mar 15, 2025

Copy link
Copy Markdown

Sorry, @donbarbos and @hugovk, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 7ae9c5dd25cccfc4e44fae6c6974ab9f32c5e985 3.12

bedevere-app Bot commented Mar 15, 2025

Copy link
Copy Markdown

GH-131293 is a backport of this pull request to the 3.13 branch.

bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Mar 15, 2025
donbarbos added a commit to donbarbos/cpython that referenced this pull request Mar 15, 2025
pythongh-130160: use .. program:: directive for documenting `http.s…
52282b8 
…erver` CLI (python#131010)

(cherry picked from commit 7ae9c5d)

bedevere-app Bot commented Mar 15, 2025

Copy link
Copy Markdown

GH-131294 is a backport of this pull request to the 3.12 branch.

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Mar 15, 2025
hugovk pushed a commit that referenced this pull request Mar 15, 2025
[3.13] gh-130160: use .. program:: directive for documenting `http.…
b7e15a9 
…server` CLI (GH-131010) (#131293)

gh-130160: use `.. program::` directive for documenting `http.server` CLI (GH-131010)
(cherry picked from commit 7ae9c5d)

Co-authored-by: donBarbos <donbarbos@proton.me>
mikec9 pushed a commit to mikec9/cpython that referenced this pull request Mar 17, 2025
[3.13] pythongh-130160: use .. program:: directive for documenting …
ec7e942 
…`http.server` CLI (pythonGH-131010) (python#131293)

pythongh-130160: use `.. program::` directive for documenting `http.server` CLI (pythonGH-131010)
(cherry picked from commit 7ae9c5d)

Co-authored-by: donBarbos <donbarbos@proton.me>
hugovk added a commit that referenced this pull request Mar 17, 2025
[3.12] gh-130160: use .. program:: directive for documenting `http.…
baea0e2 
…server` CLI (GH-131010) (#131294)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
plashchynski pushed a commit to plashchynski/cpython that referenced this pull request Mar 17, 2025
pythongh-130160: use .. program:: directive for documenting `http.s…
bfe259f 
…erver` CLI (python#131010)
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

picnixz picnixz approved these changes
hugovk hugovk approved these changes

Assignees

hugovk

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL