Improve docstrings on exceptions
Los mantenedores suelen responder en 10 días
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Comienza en tuf/api/metadata.py, en las cadenas de documentación de excepciones alrededor de las líneas referenciadas 185 y 346, y compara los dos estilos documentados. Decide una convención coherente para las cadenas de documentación de excepciones, actualiza las cadenas de documentación afectadas y documenta la convención en algún lugar del proyecto; el trabajo estará terminado cuando los estilos sean coherentes y la guía esté disponible.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Current behavior:
Currently, in tuf/api/metadata.py we are using multiple ways to document our custom TUF exceptions.
There are two main ways of how we handle exceptions:
- there are places where we define an exception with the full module name:
https://github.com/theupdateframework/python-tuf/blob/0f1fc6e33cbc4d4c6b502b9f8c64b119d1a4ad2f/tuf/api/metadata.py#L185 - and in other cases, we document only the name of the exception: https://github.com/theupdateframework/python-tuf/blob/0f1fc6e33cbc4d4c6b502b9f8c64b119d1a4ad2f/tuf/api/metadata.py#L346
Expected behavior:
Decide how we want to document our exceptions and stick to that.
Document how we should write docstrings about exceptions somewhere.
I didn't find any mentions about the exception docstrings in the Google Python guidelines
- Lenguaje dominante
- Python
- Estrellas
- 1.7k
- Forks
- 304
- Merge medio
- 9 h 25 min
- PR fusionados (30 d)
- 14
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una 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 theupdateframework/python-tuf
-
switch to main branch?Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
theupdateframework/python-tuf#3001 ·
Los mantenedores suelen responder en 10 días
-
Dificultad 4/5 3-5 días Aptitud para principiantes 42/100
theupdateframework/python-tuf#2979 · 1 comentario ·
Los mantenedores suelen responder en 10 días
-
Use Immutable ReleasesAbiertoenhancement github_actions
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
theupdateframework/python-tuf#2920 · 1 comentario · 2 reacciones ·
Los mantenedores suelen responder en 10 días
-
Investigate/test fetcher retriesAbierto
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
theupdateframework/python-tuf#2842 · 3 comentarios ·
Los mantenedores suelen responder en 10 días
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
theupdateframework/python-tuf#2836 · 7 comentarios ·
Los mantenedores suelen responder en 10 días
Todos los issues de theupdateframework/python-tuf
Issues similares
-
correction metadata
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
acl-org/acl-anthology#10104 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
bug status/needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
prowler-cloud/prowler#12885 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Bug in GaussianTailProbabilityCalibrator: running_statistics=False still uses a windowed varianceAbiertobug good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
selimfirat/pysad#107 ·
Los mantenedores suelen responder en 1 día
-
bug ci-failure high priority
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
vllm-project/vllm-omni#8194 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día