GoogleCloudPlatform / GoogleCloudPlatform/python-docs-samples

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

Open
#6,776 4 comments 0 reactions 0 assignees View on GitHub
priority: p3 samples type: cleanup
Dominant language
Jupyter Notebook
Stars
8.1k
Forks
6.7k
Avg merge
4d 2h
Merged PRs (30d)
16

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.