Top level docs are mis-placed or missing in most files
Mantenedores costumam responder em até 5 dias
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- python
- Domínio
- documentation
Direção de pesquisa
Comece revisando os comentários de nível superior e as tags de região no repositório, especialmente em storage/transfer_service, comparando-os com as orientações vinculadas sobre o estilo de snippets de código. Identifique os arquivos com comentários ausentes ou comentários dentro de tags de região e, em seguida, atualize os exemplos afetados para que os comentários descritivos fiquem fora dessas tags e não sejam mais renderizados na documentação gerada.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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.
- Linguagem predominante
- Jupyter Notebook
- Estrelas
- 8.1k
- Forks
- 6.7k
- Merge médio
- 4d 12h
- PRs com merge (30d)
- 9
Preparar o ambiente
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de GoogleCloudPlatform/python-docs-samples
-
samples
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
GoogleCloudPlatform/python-docs-samples#14609 ·
Mantenedores costumam responder em até 5 dias
-
samples
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 92/100
GoogleCloudPlatform/python-docs-samples#14610 ·
Mantenedores costumam responder em até 5 dias
-
samples
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
GoogleCloudPlatform/python-docs-samples#14611 ·
Mantenedores costumam responder em até 5 dias
-
chore(generative_ai) Update model references for generative_ai samplesTalvez livre de novo @XrossFox assumiu há 154 dias e não há nenhum pull request aberto. Abertasamples
GoogleCloudPlatform/python-docs-samples#14117 · 1 responsável ·
Mantenedores costumam responder em até 5 dias
-
Fix Pipeline dependency issues for geospatial-classification/serving_appTalvez livre de novo @XrossFox assumiu há 166 dias e não há nenhum pull request aberto. Abertasamples
GoogleCloudPlatform/python-docs-samples#14091 · 1 responsável ·
Mantenedores costumam responder em até 5 dias
Todas as issues de GoogleCloudPlatform/python-docs-samples
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
obra/superpowers#2422 ·
Mantenedores costumam responder em até 6 dias
-
triage
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 90/100
Mantenedores costumam responder em até 1 dia
-
Where is the Never optionAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
AdobeDocs/workfront.en#69 ·
-
integration: water_heater
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
home-assistant/home-assistant.io#48527 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
bytedance/trae-agent#532 · 2 comentários ·
Mantenedores costumam responder em até 1 dia