RustPython / RustPython/Parser
Use of abbreviations and jargon
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Rust
- Estrelas
- 117
- Forks
- 38
- Merge médio
- 4d 7h
- PRs com merge (30d)
- 1
Descrição
I assume that the use of abbreviating statement as stmt is for CPython compatibility. Another reason might be that it's slightly less to type but I think that's no longer a big concern, now that we have powerful IDEs like rust-analyzer.
The downside I see with using abbreviations (and chargon) is that it increases the barrier for new contributors for RustPython or downstream crates. Some of them may never have heard of stmt or what an expr is and it takes them, maybe only a little, time to understand that it is an abbreviation for statement.
That's why we at rome had the following two philosophies when it comes to naming:
- Utilize verbosity when naming commands and flags. No unnecessary and confusing abbreviations.
- Reduce jargon. Don’t assume that users will understand specific terminology. Strive to provide clear meaning for experts and beginners. For example, use “character” where you would traditionally use “token” when producing parser errors.
I'm curious to hear your perspective on this subject.
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
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
Nenhum arquivo, teste ou ponto de entrada é mencionado. Comece revisando a discussão da issue e chegando a um acordo com os maintainers sobre se é desejada uma política de nomenclatura ou um escopo concreto de renomeação. Para considerar como concluído, seria necessário ter um escopo acordado e alterações confirmadas pelos maintainers, mas a issue não define um objetivo de implementação.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- rust
- Domínio
- compilers
- Tipo de issue
- Refatoração
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 25/100