GoogleCloudPlatform / GoogleCloudPlatform/python-docs-samples

Top level docs are mis-placed or missing in most files

オープン
#6,776 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る
priority: p3 samples type: cleanup
主要言語
Jupyter Notebook
スター
8.1k
フォーク
6.7k
平均マージ
4日 2時間
マージ済み PR(30日)
16

説明

Per [go/code-snippets-style#descriptive-top-level-comment](http://goto.google.com/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.

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

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

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