python / python/cpython

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

Aberta
#125,188 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

docs
Linguagem predominante
Python
Estrelas
77.2k
Forks
36k
Métricas de merge de PRs
Métricas de PR pendentes

Descrição

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.

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Leia a documentação de urllib.parse sobre quote e as outras funções de quoting e unquoting de URL. Use a explicação existente do argumento errors de quote como referência; depois, garanta que cada uma das outras funções aponte para ela e execute o build de documentação relevante para verificar os links e a redação.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
55/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.