Tutorial - Section 4 Has Numerous Problems
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 77.2k
- Forks
- 35.9k
- Métricas de merge de PR
- Métricas de PR pendientes
Descripción
Documentation
Remember, the target audience for the tutorial are people with no prior Python knowledge. Given this, there are a few problems:
- Section 4.2: The second code example uses dictionaries but they have not been introduced - and they appear again in a bullet point in Section 4.6.
- Section 4.2: (Same code example.) Furthermore, while
usersandusers.copy()might make some intuitive sense, a brief explanation of whatitems()does seems necessary, otherwise people will think "I guess I just have to write this even though I have no idea why". - Section 4.6:
__match_args__is poorly introduced. It is explained that if it's set a certain way, it's possible to write patterns in a certain way but it's not made clear how to set it until the following example, which is about nesting patterns. This might lead readers to get stuck before it's even clarified. - Section 4.6: It seems like some of the bullet points at the end of this section were written in a rush, assume prior knowledge of Python, and do not follow the pace of the tutorial. (We've had a bunch of questions on Discord from people who essentially didn't understand anything that was written there.)
It seems like a lot of this has been copied over almost verbatim from PEP-636, which shares the same problems.
Guía de contribución
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
Empieza leyendo las secciones 4.2 y 4.6 del tutorial y, después, compara el material relacionado en PEP-636. Comprueba que dictionaries e items() se introduzcan antes de usarlos, que match_args se explique antes de su sintaxis de patrones y que los puntos finales sean comprensibles para lectores sin conocimientos previos de Python. Se considerará terminado cuando estas secciones sean comprensibles sin las preguntas de Discord descritas en la issue.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100