GoogleCloudPlatform / GoogleCloudPlatform/python-docs-samples
Top level docs are mis-placed or missing in most files
未關閉
priority: p3
samples
type: cleanup
- 主要語言
- Jupyter Notebook
- 星號
- 8.1k
- 分支
- 6.7k
- 平均合併
- 4 天 2 小時
- 30 天內合併 PR
- 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 還沒有評估資料。