GoogleCloudPlatform / GoogleCloudPlatform/python-docs-samples

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

Aperta
#6,776 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub
priority: p3 samples type: cleanup
Lingua principale
Jupyter Notebook
Stelle
8.1k
Fork
6.7k
Merge medio
4g 2h
PR unite (30g)
16

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.