Skip to content
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.

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

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

donBarbos
Copy link
Contributor

@donBarbos donBarbos commented Mar 9, 2025

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

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

@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.

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

picnixz commented Mar 9, 2025

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

@donBarbos
Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review docs Documentation in the Doc dir needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

2 participants