Improve examples in docstrings
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 42/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Empieza revisando el pull request #433 y los docstrings existentes que analiza. Identifica los ejemplos que usan sample-data o no siguen el formato de doctest de NumPy indicado; se considera terminado cuando los ejemplos seleccionados funcionan, son autocontenidos siempre que sea posible, usan datos publicados de PhysioNet cuando corresponde y siguen un estilo coherente.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Pull request #433 brings to mind some things that could be improved in docstrings more generally. Cleaning these up might be a good starter issue.
-
Obviously, code examples should be correct and actually work. :)
-
Code examples should also be self-contained if possible, and avoid referring to files in
sample-data(most people reading the documentation are probably not running the code directly from the git repository.) In most cases, it's better to use examples from published databases on PhysioNet. -
Code examples should be written in a consistent style. We generally use numpy style (https://numpydoc.readthedocs.io/en/latest/format.html) for docstrings, but we haven't been entirely consistent. In particular, numpy style requires examples to be written in "doctest" style, like this:
"""
Examples
--------
>>> np.add([[1, 2], [3, 4]],
... [[5, 6], [7, 8]])
array([[ 6, 8],
[10, 12]])
"""
This format has some nice properties (it can be tested automatically by doctest, and formatted nicely by sphinx.) On the other hand, the "..." is a little annoying when you want to copy and paste an example.
- Lenguaje dominante
- Jupyter Notebook
- Estrellas
- 853
- Forks
- 323
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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 MIT-LCP/wfdb-python
-
`find_local_peaks` ignores the sample at `i + radius`, so points on a rising slope are returned as peaksPosiblemente ocupada @rmz-oz la tomó hace 3 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
MIT-LCP/wfdb-python#572 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
MIT-LCP/wfdb-python#568 ·
-
Add validation of segments when writing a `MultiRecord`Posiblemente ocupada Un pull request vinculado a esta issue está abierto o ya se fusionó. Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
MIT-LCP/wfdb-python#557 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 58/100
MIT-LCP/wfdb-python#554 ·
-
WFDB path ignoredAbierto
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
MIT-LCP/wfdb-python#545 ·
Todos los issues de MIT-LCP/wfdb-python
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 78/100
pyca/verified-garbage#1023 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
quickemu-project/quickemu#1960 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
-
area/docs
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día