python / python/cpython

urllib.parse - quote/unquote documentation issues

Abierto
#133,930 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

https://docs.python.org/3/library/urllib.parse.html

  1. It's my understanding that the arguement in the displayed usage shows the default. So:
    urllib.parse.quote(string, safe='/', encoding=None, errors=None)
    means that errors defaults to NoneType, however, the documentation just below that says:

"errors defaults to 'strict'

  1. quote: There isn't a list of possible values for the "errors" argument

  2. unquote - There isn't a list of possible values for the "errors" argument

  3. unquote -

errors defaults to 'replace', meaning invalid sequences are replaced by a placeholder character.

What "placeholder character" is it that's used?

  1. unquote

encoding defaults to 'utf-8'. errors defaults to 'replace', meaning invalid sequences are replaced by a placeholder character.

Is a single line. errors should be on a new line (all arguements for all functions really should always be on a new line unless there's a compelling reason not to. To do otherwise significantly impedes readability, while increasing the chances of misunderstanding).

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

Comienza con la página de documentación enlazada de urllib.parse y revisa las firmas de quote y unquote, así como las descripciones de los parámetros circundantes. Resuelve los valores predeterminados indicados, las listas de valores de errors, la explicación del carácter de sustitución y los problemas de formato, de modo que la página documente claramente los argumentos y el comportamiento de cada funció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
Bastante claro
Aptitud para principiantes
52/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.