RustPython / RustPython/Parser
Use of abbreviations and jargon
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Rust
- Estrellas
- 117
- Forks
- 38
- Merge medio
- 4 d 7 h
- PR fusionados (30 d)
- 1
Descripción
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.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
No se nombran archivos, pruebas ni puntos de entrada. Empieza revisando la discusión del issue y acordando con los maintainers si se busca una política de nombres o un alcance concreto de renombrado. Para darlo por terminado, sería necesario contar con un alcance acordado y cambios confirmados por los maintainers, pero el issue no define un objetivo de implementación.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- rust
- Área
- compilers
- Tipo de issue
- Refactorización
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100