Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

csv_to_wfdb docstring has incorrect parameter descriptions

Aperta Adatta ai principianti
  • Qualcosa non va?
#594 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
83/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Individua la docstring di csv_to_wfdb in src/wfdb/io/convert/csv.py e confronta le descrizioni dei parametri con gli argomenti e il comportamento della funzione. Controlla i nomi dei segnali predefiniti segnalati vicino alla riga 323. Correggi le descrizioni errate, quindi verifica che il testo descriva accuratamente gli argomenti, incluso il fatto che fs è obbligatorio e file_name è il percorso del CSV.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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_name is copied from rdrecord. It says the name is given "without any file extensions" and refers to pn_dir, which csv_to_wfdb doesn't have. It should be the path to the CSV file.
  • fs says "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.
  • header says the default signal names are [ch_1, ch_2, ...], but the code produces ch_0, ch_1, ... (https://github.com/MIT-LCP/wfdb-python/blob/b8914e1c9c777c45571c894cb7b6579550a86f13/src/wfdb/io/convert/csv.py#L323).
Lingua principale
Jupyter Notebook
Stelle
853
Fork
324
Merge medio
17h 39m
PR unite (30g)
10

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di MIT-LCP/wfdb-python

Tutte le issue di MIT-LCP/wfdb-python

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.