Generate docstrings programmatically to reduce all the duplication

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

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

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
リファクタリング
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
python
領域
documentation

調査の方向性

この issue にはファイル、テスト、エントリーポイントが記載されていません。まず、重複している docstring と、コンパイル済みドキュメントの生成パスを特定します。共有されたプログラムによる定義から、重複した保守なしに同等のレンダリング結果のドキュメントが生成されれば完了です。

索引モデルが issue の本文から書いたものです。

説明

docs technical debt

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

環境構築

はじめの一歩

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

RadioAstronomySoftwareGroup/pyuvdata のほかの issue

RadioAstronomySoftwareGroup/pyuvdata の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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