GoogleCloudPlatform / GoogleCloudPlatform/python-docs-samples

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

Aberta
#6,776 4 comentários 0 reações 0 responsáveis Ver no GitHub
priority: p3 samples type: cleanup
Linguagem predominante
Jupyter Notebook
Estrelas
8.1k
Forks
6.7k
Merge médio
4d 2h
PRs com merge (30d)
16

Descrição

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.

Guia de contribuição

Abrir o guia de contribuição

Avaliação

Esta issue ainda não foi avaliada.

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.