python / python/cpython

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

Abierto
#125,188 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Lee la documentación de urllib.parse sobre quote y las demás funciones para citar y descitar URL. Usa como referencia la explicación existente del argumento errors de quote y, después, asegúrate de que cada una de las demás funciones apunte a ella y ejecuta la compilación de documentación pertinente para comprobar los enlaces y la redacción.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
55/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.