Generate docstrings programmatically to reduce all the duplication
Los mantenedores suelen responder en 3 días
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Refactorización
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
El issue no menciona archivos, pruebas ni puntos de entrada. Empieza localizando los docstrings repetidos y la ruta de generación de la documentación compilada; el trabajo estará terminado cuando las definiciones programáticas compartidas produzcan documentación renderizada equivalente sin mantenimiento duplicado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
We should define docstrings that get repeated in one place and programmatically add them to all the appropriate methods/functions. This will reduce the maintenance burden of keeping them all in sync and render just as nicely for users. Developers working on the code may have to look at the compiled docs to understand things, but we agreed that was worth the reduced maintenance burden.
- Lenguaje dominante
- Python
- Estrellas
- 103
- Forks
- 40
- Merge medio
- 4 d 11 h
- PR fusionados (30 d)
- 13
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 RadioAstronomySoftwareGroup/pyuvdata
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
RadioAstronomySoftwareGroup/pyuvdata#1751 ·
Los mantenedores suelen responder en 3 días
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
RadioAstronomySoftwareGroup/pyuvdata#1750 ·
Los mantenedores suelen responder en 3 días
-
Dificultad 3/5 Medio día Aptitud para principiantes 48/100
RadioAstronomySoftwareGroup/pyuvdata#1749 ·
Los mantenedores suelen responder en 3 días
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
RadioAstronomySoftwareGroup/pyuvdata#1748 ·
Los mantenedores suelen responder en 3 días
-
Documentation updatesAbierto
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
RadioAstronomySoftwareGroup/pyuvdata#1743 ·
Los mantenedores suelen responder en 3 días
Todos los issues de RadioAstronomySoftwareGroup/pyuvdata
Issues similares
-
Internal ErrorAbiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
frappe/frappe_docker#2071 ·
Los mantenedores suelen responder en 1 día
-
bug python
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
traceloop/openllmetry#4717 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
The-Pocket/PocketFlow#161 ·
-
[Bug]: Webapp workspace fails to render in Safari — "Can't find variable: requestIdleCallback"Abiertocomp/desktop P2 type/bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
NousResearch/hermes-agent#157702 ·
Los mantenedores suelen responder en 1 día
-
scibench_physics / scibench_chemistry: a correct answer scores 0 when the unit has a power of tenPosiblemente ocupada @BahaaMattar la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
EvolvingLMMs-Lab/lmms-eval#1699 ·
Los mantenedores suelen responder en 1 día