Top level docs are mis-placed or missing in most files
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Inizia esaminando i commenti di primo livello e i tag di regione nel repository, in particolare sotto storage/transfer_service, confrontandoli con le linee guida collegate sullo stile degli snippet di codice. Individua i file con commenti mancanti o con commenti all’interno dei tag di regione, quindi aggiorna gli esempi interessati in modo che i commenti descrittivi si trovino all’esterno di tali tag e non vengano più visualizzati nella documentazione generata.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Per go/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.
- Lingua principale
- Jupyter Notebook
- Stelle
- 8.1k
- Fork
- 6.7k
- Merge medio
- 4g 4h
- PR unite (30g)
- 8
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di GoogleCloudPlatform/python-docs-samples
-
samples
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
-
samples
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
-
samples
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
-
samples
GoogleCloudPlatform/python-docs-samples#14117 · 1 assegnatario ·
-
samples
GoogleCloudPlatform/python-docs-samples#14091 · 1 assegnatario ·
Tutte le issue di GoogleCloudPlatform/python-docs-samples
Issue simili
-
rules
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
-
difficulty/starter 🚀 good first issue kind/consumer-experience kind/documentation platform/ios 🍎 platform/wasm 🌐 project/documentation 📖 project/non-ui ⚙️ triage/untriaged
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 95/100
unoplatform/uno#24649 ·
-
sync-en
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
-
sync-en
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
-
Перевод устарел
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100