Better encapsulation of record metadata
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Jupyter Notebook
- Estrellas
- 853
- Forks
- 322
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
Right now we have the Record class with a huge number of attributes in the top level object. These attributes are varied, fall into many categories, and become very hard to keep track of.
I also find it rather awkward that there is no separate 'header' or 'metadata' type of object. ie. rdheader and rdrecord both return the same type of object.
Initial idea:
RecordInfoclass for storing all the header data. Includes record and signal specification fields, and comments.rdheaderwill create this type.- Same
Recordclass for WFDB records. Theinfoattribute will be aRecordInfoobject.
Having the top level p_signal, d_signal attributes is not my favorite, but I feel like it's rather pointless to have another object to capture these fields.
Open to suggestions.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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.
Línea de trabajo
Comienza leyendo la clase Record existente y los puntos de entrada rdheader y rdrecord mencionados en el issue, identificando qué atributos de nivel superior representan los datos del header, de la especificación de señales y de los comentarios. Define el límite previsto de RecordInfo y comprueba cómo utilizan los llamadores estos atributos; se considera terminado cuando la propuesta de encapsulación es coherente y sus efectos sobre ambos tipos de objetos devueltos están documentados.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- backend-api-design
- Tipo de issue
- Refactorización
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100