HTTP modules documentation displays a list of both unsupported http and supported codes, contrary to caption.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
The HTTP module supports status codes that are unregistered/unofficial. Take http status code 418: I'm a teapot Due to the save418 movement (https://save418.com/), python decided to preserve http code 418 in its codebase, but this documentation contradicts itself.
However, in the documentation, right above the table of status codes supported by the http library we have this:
Supported, IANA-registered status codes available in http.HTTPStatus are:
This is factually incorrect, because code 418, (among others) is not official, and this should either be edited to say:
"Supported Status Codes Available in http.httpStatus are:" or list exceptions.
Linked PRs
- gh-135625
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the HTTP module documentation passage above the status-code table and compare its caption with the codes listed, including 418. Update the wording so it accurately describes the supported codes, then verify the rendered documentation; linked PR gh-135625 indicates that work is already underway.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100