Update documentation to use generators
@aashraybhandar1 がすでに取り組んでいます。
2018年4月7日 から。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python
- 領域
- cli, documentation
調査の方向性
まず、CLI Helpers の出力をリストとして説明している quick-start および API ドキュメントのセクションを読んでください。それらの記述をジェネレーターを説明する内容に更新し、両方のドキュメント領域が現在の動作を一貫して反映していることを確認してください。
索引モデルが issue の本文から書いたものです。
説明
The current documentation assumes that the output format is a list, but CLI Helpers now returns generators. We should update the quick start and the API documentation.
- 主要言語
- Python
- スター
- 104
- フォーク
- 33
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
dbcli/cli_helpers のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
dbcli/cli_helpers#50 · コメント 2 件 ·
dbcli/cli_helpers の issue をすべて見る
似ている issue
-
area: agents area: docs good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
openapi/gknowledge#23 ·
-
get() for StrEnum対応中かも @FeJo5952 が今日担当しました。 オープンgood first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
collective/icalendar#1921 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Improvement Python Spans
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
getsentry/sentry-python#7994 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
alphagov/notifications-api#5004 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
equinor/radix-flux#3922 ·
メンテナーはふだん 1 日以内に返信