Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

csv_to_wfdb docstring has incorrect parameter descriptions

オープン 初心者向け
  • 何か問題がありますか？
#594 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
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分
マージ済み PR（30日）
10

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

MIT-LCP/wfdb-python のほかの issue

MIT-LCP/wfdb-python の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。