python / python/cpython

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

Ouverte
#135,615 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

docs
Langage dominant
Python
Étoiles
77.2k
Forks
35.9k
Métriques de merge des PR
Métriques de PR en attente

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par le passage de la documentation du module HTTP situé au-dessus du tableau des codes d’état et comparez sa légende aux codes listés, notamment 418. Mettez à jour la formulation afin qu’elle décrive correctement les codes pris en charge, puis vérifiez la documentation rendue ; le PR lié gh-135625 indique que ce travail est déjà en cours.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
Moins d'une heure
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.