Top level docs are mis-placed or missing in most files
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
まず、リポジトリ内のトップレベルコメントとリージョンタグを、特に storage/transfer_service 配下について、リンク先のコードスニペットのスタイルガイドに照らして確認します。コメントが不足しているファイル、またはリージョンタグ内にコメントがあるファイルを特定し、その後、影響を受けるサンプルを更新して、説明用コメントがそれらのタグの外側に配置され、生成されたドキュメントにレンダリングされないようにします。
索引モデルが issue の本文から書いたものです。
説明
Per go/code-snippets-style#descriptive-top-level-comment, we should have top level comments that are placed outside of the region tags, to describe the snippets.
From a brief walk through some parts of the repo, I'm noticing most files don't have the top level comment at all, and I also a noticed a number of them, particularly in storage/transfer_service where they are wrongly placed inside the bounds of the region tag, causing them to render in the c.g.c docs, which doesn't seem is the desirable functionality.
- 主要言語
- Jupyter Notebook
- スター
- 8.1k
- フォーク
- 6.7k
- 平均マージ
- 4日 4時間
- マージ済み PR（30日）
- 8
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
GoogleCloudPlatform/python-docs-samples のほかの issue
-
samples
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
-
samples
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
-
samples
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
-
samples
GoogleCloudPlatform/python-docs-samples#14117 · 担当者 1 名 ·
-
samples
GoogleCloudPlatform/python-docs-samples#14091 · 担当者 1 名 ·
GoogleCloudPlatform/python-docs-samples の issue をすべて見る
似ている issue
-
Link Checker Report オープンautomated issue report
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
-
documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
components-web-app/docs#99 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
TheOdinProject/curriculum#31423 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
-
hcocena オープンpolicies-accepted pre-review precheck-passed
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
Bioconductor/BiocContributions#214 · コメント 5 件 ·