python / python/docs-community
ABC documentation needs more details on usage
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Makefile
- Estrellas
- 55
- Forks
- 26
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
I am trying to use Abstract Base Classes. But I find the documentation lacking on several points that makes the matter too 'abstract'.
For example. There is no explanation on making abstract objects mandatory by using exceptions
Or how to implement Iterable abstract bsse class that can be inherited from and still be usable.
Can someone shed more light onto this so that the documentation is more accessible?
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
Comienza localizando la documentación de Abstract Base Classes y revisando su cobertura actual de los objetos abstractos, las excepciones y la herencia de Iterable. La tarea estará terminada cuando la documentación explique claramente los patrones de uso solicitados y haga que los ejemplos sean accesibles para los lectores; en el issue no se mencionan archivos ni pruebas específicos.
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
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 35/100