python / python/cpython

docs: improve explanation of the `errors` argument of `urllib.parse` functions

Ouverte
#125,188 2 commentaires 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 URL quoting/unquoting functions in urllib.parse all have an errors argument, which is passed on to internal encode and decode functions.

The full explanation of what errors means is only explained in urllib.parse.quote.
The documentation for the other functions explains the the default behavior, but not any alternatives.

Each other function's documentation should should point to urllib.parse.quote for an explanation of errors.

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

Consultez la documentation de urllib.parse sur quote et les autres fonctions de quotation et de déquotation d’URL. Utilisez l’explication existante de l’argument errors de quote comme référence, puis assurez-vous que chaque autre fonction y renvoie et exécutez le build de documentation pertinent pour vérifier les liens et la formulation.

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é
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
55/100

Recevez les nouvelles issues par e-mail

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