Docu: missing return values for Checker.check_all()
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 42/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Comienza localizando Checker.check_all() en el único archivo fuente de Python del repositorio y compara su comportamiento con la documentación de ReadTheDocs. Documenta los argumentos del método, el valor de retorno y las excepciones que genera; después, comprueba si el código fuente correspondiente y las entradas de ReadTheDocs coinciden. Se considera terminado cuando el comportamiento del retorno está claro para los usuarios y la documentación relevante está completa.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
The docu on source and on readthedocs is unclear about if and what Checker.check_all() returns.
Of course I can read the source and find the answer. But it would easier for all users if all classes and methods would provide a full documentation in the docstring on all arguments, return values and raised exceptions.
- Lenguaje dominante
- Python
- Estrellas
- 5.2k
- Forks
- 754
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
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.
Más de PyCQA/pycodestyle
-
DOC: E252 is not documentedAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 82/100
PyCQA/pycodestyle#1294 · 1 comentario ·
-
Typing and formattingAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
PyCQA/pycodestyle#1302 · 3 comentarios ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 42/100
PyCQA/pycodestyle#1242 · 2 comentarios ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
PyCQA/pycodestyle#1241 · 2 comentarios · 4 reacciones ·
-
`exclude` is applied to `.`Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
PyCQA/pycodestyle#1217 ·
Todos los issues de PyCQA/pycodestyle
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
letsencrypt/cp-cps#353 ·
-
Marble Madness II is missingAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
PedestrianDynamics/pyFDS-Evac#394 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
DOI-USGS/pywatershed#421 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
python-pillow/Pillow#10087 · 1 comentario ·
Los mantenedores suelen responder en 1 día