Docstrings
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
まず、iPython で help(odml.Section) を使ってドキュメント化された例を再現し、関連するクラスの init docstring を確認します。docstring を繰り返すべきかクラスに移動すべきかを判断し、その後、help(odml.Section) に意図した情報が表示されることを確認します。
索引モデルが issue の本文から書いたものです。
説明
While writing the tutorial I realized that the help function in iPython does not always provide proper information. I think the docstrings of the init functions need to be repeated or moved to the class.
Example:
help(odml.Section)
-> returns
Section(*args, **kwargs)
- 主要言語
- Python
- スター
- 25
- フォーク
- 30
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
G-Node/python-odml のほかの issue
-
RDF
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
G-Node/python-odml#172 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 58/100
G-Node/python-odml#420 ·
-
Sparse file outputオープン
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
G-Node/python-odml#418 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
G-Node/python-odml#417 · コメント 8 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
G-Node/python-odml#406 ·
G-Node/python-odml の issue をすべて見る
似ている issue
-
bug status/needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
prowler-cloud/prowler#12887 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
area: desktop platform: macos priority: p3 status: ready type: enhancement
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
use-agent-os/agent-os#3484 ·
メンテナーはふだん 2 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
open-telemetry/opentelemetry-python-contrib#5113 · コメント 2 件 · リアクション 2 件 ·
メンテナーはふだん 1 日以内に返信
-
external
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
langchain-ai/docs#6255 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信