Skip to content

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

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.

Sign up for GitHub

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

Jump to bottom
Merged
hugovk merged 5 commits into from
Mar 15, 2025
Merged

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

hugovk merged 5 commits into from
Mar 15, 2025

Conversation

@donbarbos
Copy link
Contributor

@donbarbosdonbarbos commented Mar 9, 2025•
edited
Loading

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 branchPR branch
Screenshot from 2025-03-09 18-41-16Screenshot from 2025-03-09 18-55-30

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

@bedevere-appbedevere-appbot added docs Documentation in the Doc dir skip news awaiting review labels Mar 9, 2025
@bedevere-appbedevere-appbot mentioned this pull request Mar 9, 2025
Closed
6 tasks
@picnixz
Copy link
Member

picnixz commented Mar 9, 2025

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.

@picnixzpicnixz added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Mar 9, 2025
@picnixz
Copy link
Member

picnixz commented Mar 9, 2025•
edited
Loading

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

@donbarbos
Copy link
ContributorAuthor

donbarbos commented Mar 10, 2025

Section was updated:

Screenshot from 2025-03-10 07-17-44

@picnixz
Copy link
Member

picnixz commented Mar 10, 2025

I'll review it at home

@picnixzpicnixz self-requested a review March 13, 2025 17:08
picnixz
picnixz reviewed Mar 15, 2025
View reviewed changes
picnixz
picnixz approved these changes Mar 15, 2025
View reviewed changes
Copy link
Member

@picnixzpicnixz left a comment

Choose a reason for hiding this comment

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

LGTM.

@picnixzpicnixz requested a review from hugovkMarch 15, 2025 12:38
hugovk
hugovk approved these changes Mar 15, 2025
View reviewed changes
Copy link
Member

@hugovkhugovk left a comment

Choose a reason for hiding this comment

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

Thanks!

@donbarbos
Copy link
ContributorAuthor

donbarbos commented Mar 15, 2025

Thank you for review

@hugovkhugovk merged commit 7ae9c5d into python:mainMar 15, 2025
24 checks passed
@github-project-automationgithub-project-automationbot moved this from Todo to Done in Docs PRsMar 15, 2025
@miss-islington-app
Copy link

miss-islington-appbot commented Mar 15, 2025

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
@donbarbos@miss-islington
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
Copy link

miss-islington-appbot commented Mar 15, 2025

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
Copy link

bedevere-appbot commented Mar 15, 2025

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

@bedevere-appbedevere-appbot 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
@donbarbos
pythongh-130160: use.. program::directive for documenting `http.s…
52282b8
…erver` CLI (python#131010) (cherry picked from commit 7ae9c5d)
@bedevere-app
Copy link

bedevere-appbot commented Mar 15, 2025

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

@bedevere-appbedevere-appbot 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
@miss-islington@donbarbos
[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
@miss-islington@donbarbos
[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
@donbarbos@hugovk
[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
@donbarbos@plashchynski
pythongh-130160: use.. program::directive for documenting `http.s…
bfe259f
…erver` CLI (python#131010)
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@picnixzpicnixzpicnixz approved these changes

@hugovkhugovkhugovk approved these changes

Assignees

@hugovkhugovk

Labels

docsDocumentation in the Doc dirskip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@donbarbos@picnixz@hugovk