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

Jump to bottom

Clarify http.server documentation using RFC 7230 terminology #93166

Open
maggyero opened this issue May 24, 2022 · 1 comment · May be fixed by #30686
Open

Clarify http.server documentation using RFC 7230 terminology #93166

maggyero opened this issue May 24, 2022 · 1 comment · May be fixed by #30686
Labels
docs

Comments

@maggyero
Copy link
Contributor

@maggyero maggyero commented May 24, 2022 •
edited

The linked PR will clarify the descriptions of methods and attributes in the http.server documentation using RFC 7230 terminology.

It will also document the optional directory parameter of CGIHTTPRequestHandler(request, client_address, server, directory=None) inherited from SimpleHTTPRequestHandler(request, client_address, server, directory=None).
@maggyero maggyero added the docs label May 24, 2022
@merwok merwok linked a pull request May 24, 2022 that will close this issue
Open
@merwok merwok linked a pull request May 24, 2022 that will close this issue
gh-93166: Clarify http.server documentation using RFC 7230 terminology #30686
Open
@erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented May 24, 2022

We should clarify the descriptions of methods and attributes in the http.server documentation using RFC 7230 terminology.

Why? Please provide a reason and rationale for your changes. It makes it easier to decide if one should go to the next step of implementing a change. It also makes it easier to review the proposed change.

We should also document the optional directory parameter of CGIHTTPRequestHandler(request, client_address, server, directory=None) inherited from SimpleHTTPRequestHandler(request, client_address, server, directory=None).

Ditto; explain why. Don't just say "we should". Explain the problem with the status quo. Explain the possible benefits of a possible change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

gh-93166: Clarify http.server documentation using RFC 7230 terminology maggyero/cpython
2 participants
@erlend-aasland @maggyero