Generate docstrings programmatically to reduce all the duplication
メンテナーはふだん 3 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- リファクタリング
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
この issue にはファイル、テスト、エントリーポイントが記載されていません。まず、重複している docstring と、コンパイル済みドキュメントの生成パスを特定します。共有されたプログラムによる定義から、重複した保守なしに同等のレンダリング結果のドキュメントが生成されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
We should define docstrings that get repeated in one place and programmatically add them to all the appropriate methods/functions. This will reduce the maintenance burden of keeping them all in sync and render just as nicely for users. Developers working on the code may have to look at the compiled docs to understand things, but we agreed that was worth the reduced maintenance burden.
- 主要言語
- Python
- スター
- 103
- フォーク
- 40
- 平均マージ
- 4日 11時間
- マージ済み PR(30日)
- 13
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
RadioAstronomySoftwareGroup/pyuvdata のほかの issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
RadioAstronomySoftwareGroup/pyuvdata#1751 ·
メンテナーはふだん 3 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
RadioAstronomySoftwareGroup/pyuvdata#1750 ·
メンテナーはふだん 3 日以内に返信
-
難易度 3/5 半日 初心者へのやさしさ 48/100
RadioAstronomySoftwareGroup/pyuvdata#1749 ·
メンテナーはふだん 3 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
RadioAstronomySoftwareGroup/pyuvdata#1748 ·
メンテナーはふだん 3 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
RadioAstronomySoftwareGroup/pyuvdata#1743 ·
メンテナーはふだん 3 日以内に返信
RadioAstronomySoftwareGroup/pyuvdata の issue をすべて見る
似ている issue
-
Internal Errorオープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
frappe/frappe_docker#2071 ·
メンテナーはふだん 1 日以内に返信
-
bug python
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
traceloop/openllmetry#4717 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
The-Pocket/PocketFlow#161 ·
-
comp/desktop P2 type/bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
NousResearch/hermes-agent#157702 ·
メンテナーはふだん 1 日以内に返信
-
scibench_physics / scibench_chemistry: a correct answer scores 0 when the unit has a power of ten対応中かも @BahaaMattar が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
EvolvingLMMs-Lab/lmms-eval#1699 ·
メンテナーはふだん 1 日以内に返信