csv_to_wfdb docstring has incorrect parameter descriptions
Los mantenedores suelen responder en 1 día
Ya se ha fusionado un pull request relacionado.
- #600 de @TheNetherWatcher — fusionado
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 83/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Busca el docstring de csv_to_wfdb en src/wfdb/io/convert/csv.py y compara las descripciones de sus parámetros con los argumentos y el comportamiento de la función. Comprueba los nombres de señal predeterminados indicados cerca de la línea 323. Corrige las descripciones incorrectas y confirma que el texto describe con precisión los argumentos, incluido que fs es obligatorio y file_name es la ruta del CSV.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Found while reviewing #591, which fixes the summary, record_only, write_dir and return value descriptions. Some other parameter descriptions in the csv_to_wfdb docstring are wrong, mostly because they were copied from elsewhere:
file_nameis copied fromrdrecord. It says the name is given "without any file extensions" and refers topn_dir, whichcsv_to_wfdbdoesn't have. It should be the path to the CSV file.fssays "if it is missing, a value of 250 is assumed", but it is a required argument.- Several other descriptions (e.g.
baseline,skew,byte_offset,checksum) are copied from the header file specification and describe header syntax rather than the Python arguments. headersays the default signal names are[ch_1, ch_2, ...], but the code producesch_0, ch_1, ...(https://github.com/MIT-LCP/wfdb-python/blob/b8914e1c9c777c45571c894cb7b6579550a86f13/src/wfdb/io/convert/csv.py#L323).
- Lenguaje dominante
- Jupyter Notebook
- Estrellas
- 856
- Forks
- 326
- Merge medio
- 1 d 12 h
- PR fusionados (30 d)
- 36
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
-
Record.wrsamp() fails with a TypeError when the record has no d_signalPosiblemente ocupada @divya-git03 la tomó hace 1 día. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
MIT-LCP/wfdb-python#618 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
MIT-LCP/wfdb-python#590 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
pandas 3.0: three remaining set_index(<str column>.values) calls still raise TypeError (custom-labels paths)Posiblemente ocupada @wenh06 la tomó hace 10 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
MIT-LCP/wfdb-python#574 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
ann2rr filters intervals by length instead of by time in the recordPosiblemente ocupada @TheNetherWatcher la tomó hace 1 día. Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 72/100
MIT-LCP/wfdb-python#617 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
MIT-LCP/wfdb-python#568 ·
Los mantenedores suelen responder en 1 día
Todos los issues de MIT-LCP/wfdb-python
Issues similares
-
bug: ARCHITECTURE.md states three different workflow counts (88 / 69 / 69) and no test pins themAbiertoarea:docs area:workflow bug documentation priority:later
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Ikalus1988/MisakaNet#4357 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
aws-samples/sample-per-model-bedrock#708 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
voidzero-dev/void#677 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
ocaml-multicore/eio#962 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
microsoft/ML-For-Beginners#1061 ·