python / python/cpython

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

Aperta
#135,615 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

docs
Lingua principale
Python
Stelle
77.2k
Fork
35.9k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dal passaggio della documentazione del modulo HTTP sopra la tabella dei codici di stato e confronta la relativa didascalia con i codici elencati, incluso 418. Aggiorna la formulazione in modo che descriva accuratamente i codici supportati, quindi verifica la documentazione renderizzata; il PR collegato gh-135625 indica che il lavoro è già in corso.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
Meno di un'ora
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.