Missing docs for rdedfann (and other functions)
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 853
- Forks
- 322
- PR merge metrics
- No merged PRs in 30d
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the public functions in the wfdb package with the API entries in docs/wfdb.rst, docs/io.rst, docs/plot.rst, and docs/processing.rst, beginning with wfdb.rdedfann and its wfdb.io.rdedfann alias. Identify other public functions missing from those documents and update the relevant API documentation so the considered public API is listed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100