Missing docs for rdedfann (and other functions)
Nessuno ha ancora preso questa issue.
- Lingua principale
- Jupyter Notebook
- Stelle
- 853
- Fork
- 322
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
The function wfdb.rdedfann (alias wfdb.io.rdedfann) is not listed in the public documentation.
Make a list here of other functions that should be considered part of the public API, but are not listed in docs/wfdb.rst / docs/io.rst / docs/plot.rst / docs/processing.rst.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia confrontando le funzioni pubbliche nel pacchetto wfdb con le voci API in docs/wfdb.rst, docs/io.rst, docs/plot.rst e docs/processing.rst, cominciando da wfdb.rdedfann e dal suo alias wfdb.io.rdedfann. Identifica le altre funzioni pubbliche mancanti in questi documenti e aggiorna la documentazione API pertinente in modo che venga elencata l’API considerata pubblica.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 35/100