Write and require docstrings for public module functions
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- cli, documentation
Línea de trabajo
Empieza revisando el issue #42 e identifica la funcionalidad principal que se está trasladando a un módulo de Python. Enumera sus funciones públicas y decide qué estilo de docstring y qué enfoque de linting encajan con el proyecto. Se considerará terminado cuando las funciones públicas del módulo tengan docstrings que reflejen su uso y una prueba o comprobación de lint verifique su presencia.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
As part of https://github.com/mapbox/tilesets-cli/issues/42, we'll be moving core functionality to a python module. All public module functions should have a docstring reflecting the usage of said function.
Some initial ideas are:
- Use numpy style docstrings https://numpydoc.readthedocs.io/en/latest/format.html
- Have a linting test that verifies docstring existence
cc @Gerdie
- Lenguaje dominante
- Python
- Estrellas
- 141
- Forks
- 27
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la 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.
Más de mapbox/tilesets-cli
-
Dificultad 4/5 3-5 días Aptitud para principiantes 28/100
mapbox/tilesets-cli#217 · 1 comentario ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
mapbox/tilesets-cli#216 · 2 comentarios ·
-
Tilesets not recognized?Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 25/100
mapbox/tilesets-cli#193 · 1 comentario ·
-
Click version supportAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
mapbox/tilesets-cli#190 · 1 reacción ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
mapbox/tilesets-cli#171 · 1 reacción ·
Todos los issues de mapbox/tilesets-cli
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
pyjanitor-devs/pyjanitor#1758 ·
Los mantenedores suelen responder en 1 día
-
bug ready for review
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
odysseus-dev/odysseus#6641 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
happypawspillaro/happypaws#78 ·
Los mantenedores suelen responder en 4 días
-
pydanty:is-working
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
pydantic/pydantic-ai#10020 ·
Los mantenedores suelen responder en 1 día
-
stdlib type-bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
python/cpython#159044 · 4 comentarios ·
Los mantenedores suelen responder en 1 día