realpython / realpython/python-guide
Ambiguity in the Structure section.
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Batchfile
- Estrelas
- 29.8k
- Forks
- 5.9k
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
I'm a little confused as to what this passage from writing/structure means.
Readability means to avoid useless boilerplate text and clutter,
therefore some efforts are spent trying to achieve a certain level of brevity.
But terseness and obscurity are the limits where brevity should stop.
Could this be reworded as something like this?
Readability in this case refers to avoiding useless boilerplate text and
clutter, and some effort has been made to achieve a certain level of brevity
in Python's syntax. However, there is a fine line between terseness and
obscurity.
I'm not sure I'm correctly grasping the meaning of the text. Does it actually mean something completely different?
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece pela seção Modules de docs/writing/structure.rst, usando a passagem vinculada como escopo. Confirme o significado pretendido com a discussão existente e revise a redação somente se esse significado estiver claro; considera-se concluído quando a passagem renderizada for inequívoca e preservar a orientação original.
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
- 1/5
- Tempo estimado
- Menos de uma hora
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100