python / python/cpython

urllib.parse - quote/unquote documentation issues

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

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).

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

Comece pela página de documentação vinculada de urllib.parse e revise as assinaturas de quote e unquote e as descrições dos parâmetros ao redor. Resolva os valores padrão relatados, as listas de valores de errors, a explicação do caractere de espaço reservado e as questões de formatação, de modo que a página documente claramente os argumentos e o comportamento de cada funçã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
Razoavelmente clara
Facilidade para iniciantes
52/100

Receba novas issues na sua caixa de entrada

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