Missing docs for rdedfann (and other functions)
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Jupyter Notebook
- Sterne
- 853
- Forks
- 322
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die öffentlichen Funktionen im wfdb-Paket mit den API-Einträgen in docs/wfdb.rst, docs/io.rst, docs/plot.rst und docs/processing.rst zu vergleichen, angefangen mit wfdb.rdedfann und seinem Alias wfdb.io.rdedfann. Identifiziere weitere öffentliche Funktionen, die in diesen Dokumenten fehlen, und aktualisiere die relevante API-Dokumentation, sodass die als öffentlich betrachtete API aufgeführt ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100