csv_to_wfdb docstring has incorrect parameter descriptions
维护者通常 1 天内回复
已经有一个关联 PR 被合并了。
- #600 来自 @TheNetherWatcher —— 已合并
评估
- 难度
- 1/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 83/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- python
调研方向
在 src/wfdb/io/convert/csv.py 中找到 csv_to_wfdb 的 docstring，并将其参数描述与函数参数和行为进行比较。检查第 323 行附近报告的默认信号名称。更新错误的描述，然后确认文本准确描述了这些参数，包括 fs 为必填项且 file_name 是 CSV 路径。
由索引模型根据 Issue 内容生成。
描述
Found while reviewing #591, which fixes the summary, record_only, write_dir and return value descriptions. Some other parameter descriptions in the csv_to_wfdb docstring are wrong, mostly because they were copied from elsewhere:
file_nameis copied fromrdrecord. It says the name is given "without any file extensions" and refers topn_dir, whichcsv_to_wfdbdoesn't have. It should be the path to the CSV file.fssays "if it is missing, a value of 250 is assumed", but it is a required argument.- Several other descriptions (e.g.
baseline,skew,byte_offset,checksum) are copied from the header file specification and describe header syntax rather than the Python arguments. headersays the default signal names are[ch_1, ch_2, ...], but the code producesch_0, ch_1, ...(https://github.com/MIT-LCP/wfdb-python/blob/b8914e1c9c777c45571c894cb7b6579550a86f13/src/wfdb/io/convert/csv.py#L323).
- 主要语言
- Jupyter Notebook
- 星标
- 853
- 派生
- 324
- 平均合并
- 15 小时
- 30 天内合并 PR
- 32
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
MIT-LCP/wfdb-python 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 70/100
MIT-LCP/wfdb-python#618 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 72/100
MIT-LCP/wfdb-python#590 ·
维护者通常 1 天内回复
-
pandas 3.0: three remaining set_index(<str column>.values) calls still raise TypeError (custom-labels paths)可能已有人在做 @wenh06 于 8 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 82/100
MIT-LCP/wfdb-python#574 · 1 条评论 ·
维护者通常 1 天内回复
-
`find_local_peaks` ignores the sample at `i + radius`, so points on a rising slope are returned as peaks可能已有人在做 @rmz-oz 于 29 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 84/100
MIT-LCP/wfdb-python#572 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 72/100
MIT-LCP/wfdb-python#617 ·
维护者通常 1 天内回复
查看 MIT-LCP/wfdb-python 的全部 Issue
相似的 Issue
-
auto:doc-drift auto:producer
难度 2/5 1-3 小时 新手友好度 60/100
fritzprix/libr-agent#2458 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
w3c/csswg-drafts#14708 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
agent-ready area: docs documentation good first issue
难度 2/5 1-3 小时 新手友好度 85/100
Soneso/stellar-agent-wallet#525 ·
维护者通常 1 天内回复
-
Documentation
难度 1/5 1 小时以内 新手友好度 88/100
OWASP/SecurityShepherd#1097 ·
维护者通常 1 天内回复