MIT-LCP / MIT-LCP/wfdb-python

Missing docs for rdedfann (and other functions)

未关闭
#339 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Jupyter Notebook
星标
853
派生
322
PR 合并指标
30 天内没有已合并 PR

描述

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.

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先比较 wfdb 包中的公共函数与 docs/wfdb.rst、docs/io.rst、docs/plot.rst 和 docs/processing.rst 中的 API 条目,从 wfdb.rdedfann 及其别名 wfdb.io.rdedfann 开始。找出这些文档中缺少的其他公共函数,并更新相关 API 文档,以列出被视为公共 API 的内容。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。