MIT-LCP / MIT-LCP/wfdb-python

Missing docs for rdedfann (and other functions)

オープン
#339 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

主要言語
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. リポジトリをフォークし、ブランチを切って変更します。
  4. 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 を短くまとめたダイジェスト。