Missing docs for rdedfann (and other functions)
Personne n'a encore pris cette issue.
- Langage dominant
- Jupyter Notebook
- Étoiles
- 853
- Forks
- 322
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par comparer les fonctions publiques du package wfdb avec les entrées d’API dans docs/wfdb.rst, docs/io.rst, docs/plot.rst et docs/processing.rst, en commençant par wfdb.rdedfann et son alias wfdb.io.rdedfann. Identifiez les autres fonctions publiques absentes de ces documents et mettez à jour la documentation d’API correspondante afin que l’API considérée comme publique soit listée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 35/100