python / python/cpython

HTTP modules documentation displays a list of both unsupported http and supported codes, contrary to caption.

Offen
#135,615 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Passage in der HTTP-Moduldokumentation oberhalb der Tabelle mit den Statuscodes und vergleiche deren Bildunterschrift mit den aufgeführten Codes, einschließlich 418. Aktualisiere die Formulierung so, dass sie die unterstützten Codes korrekt beschreibt, und überprüfe anschließend die gerenderte Dokumentation; der verknüpfte PR gh-135625 zeigt, dass diese Arbeit bereits begonnen hat.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.