GoogleCloudPlatform / GoogleCloudPlatform/python-docs-samples

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

Offen
#6,776 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
priority: p3 samples type: cleanup
Vorherrschende Sprache
Jupyter Notebook
Sterne
8.1k
Forks
6.7k
Ø Merge
4 T. 2 Std.
Gemergte PRs (30 T.)
16

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.