matrix-org / matrix-org/matrix-python-sdk
Add docstrings to all public methods
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 266
- Forks
- 118
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
For instance, get_display_name in api.MatrixHttpApi needs a docstring. Many others as well.
In doing this, you may run across methods that it seems should be private rather than public; in that case, please go ahead and make method call _method while raising a deprecation warning and point all code within the sdk towards _method
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 por get_display_name en api.MatrixHttpApi, haz después un inventario de los otros métodos públicos del SDK e inspecciona sus llamadores existentes. Se considera terminado cuando cada método público tiene un docstring; los métodos considerados privados delegan mediante wrappers públicos obsoletos con advertencias, y las llamadas internas del SDK usan los nombres privados.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- api, documentation
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100