Hacktoberfest 2026:維護者為十月標記出來的 issue,仍然開放、適合新手。 瀏覽 Hacktoberfest issue

csv_to_wfdb docstring has incorrect parameter descriptions

未關閉 適合新手
#594 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
1/5
預估耗時
1-3 小時
新手友好度
83/100
Issue 類型
文件
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
python
領域
documentation

研究方向

在 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_name is copied from rdrecord. It says the name is given "without any file extensions" and refers to pn_dir, which csv_to_wfdb doesn't have. It should be the path to the CSV file.
  • fs says "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.
  • header says the default signal names are [ch_1, ch_2, ...], but the code produces ch_0, ch_1, ... (https://github.com/MIT-LCP/wfdb-python/blob/b8914e1c9c777c45571c894cb7b6579550a86f13/src/wfdb/io/convert/csv.py#L323).
主要語言
Jupyter Notebook
星號
853
分支
324
平均合併
17 小時 39 分鐘
30 天內合併 PR
10

環境準備

這個專案沒有提供開發容器、Dockerfile 或貢獻指南,環境需要你自己搭建:先看它的 README,通用步驟見我們的新手貢獻指南。

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

MIT-LCP/wfdb-python 的其他 Issue

查看 MIT-LCP/wfdb-python 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。