Top level docs are mis-placed or missing in most files
Les mainteneurs répondent en général sous 5 jours
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 35/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
Commencez par examiner les commentaires de niveau supérieur et les balises de région dans le dépôt, en particulier sous storage/transfer_service, en les comparant aux recommandations liées concernant le style des extraits de code. Identifiez les fichiers auxquels il manque des commentaires ou qui contiennent des commentaires à l’intérieur de balises de région, puis mettez à jour les exemples concernés afin que les commentaires descriptifs se trouvent en dehors de ces balises et ne soient plus rendus dans la documentation générée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- Jupyter Notebook
- Étoiles
- 8.1k
- Forks
- 6.7k
- Merge moyen
- 4 j 12 h
- PR mergées (30 j)
- 9
Préparer son environnement
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de GoogleCloudPlatform/python-docs-samples
-
samples
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
GoogleCloudPlatform/python-docs-samples#14609 ·
Les mainteneurs répondent en général sous 5 jours
-
samples
Difficulté 1/5 Moins d'une heure Accessibilité débutants 92/100
GoogleCloudPlatform/python-docs-samples#14610 ·
Les mainteneurs répondent en général sous 5 jours
-
samples
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
GoogleCloudPlatform/python-docs-samples#14611 ·
Les mainteneurs répondent en général sous 5 jours
-
chore(generative_ai) Update model references for generative_ai samplesPeut-être à nouveau libre @XrossFox l’a pris il y a 154 jours, et aucune pull request n’est ouverte. Ouvertesamples
GoogleCloudPlatform/python-docs-samples#14117 · 1 personne assignée ·
Les mainteneurs répondent en général sous 5 jours
-
Fix Pipeline dependency issues for geospatial-classification/serving_appPeut-être à nouveau libre @XrossFox l’a pris il y a 166 jours, et aucune pull request n’est ouverte. Ouvertesamples
GoogleCloudPlatform/python-docs-samples#14091 · 1 personne assignée ·
Les mainteneurs répondent en général sous 5 jours
Toutes les issues de GoogleCloudPlatform/python-docs-samples
Issues similaires
-
Provide a docinit functionaliyOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
-
documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
inu-appcenter/memorIN-frontend#106 ·
Les mainteneurs répondent en général sous 1 jour
-
workflow: a tick's dispatch counts as 'only this step', and no review self-grants a round unattendedOuverteworkflow
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
kristofdegrave/homeassistant-smart-charging#1505 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
openfoodfacts/score-my-recipe#80 ·
Les mainteneurs répondent en général sous 2 jours
-
documentation
Difficulté 1/5 Moins d'une heure Accessibilité débutants 92/100
githubnext/gh-aw-workshop#3968 ·
Les mainteneurs répondent en général sous 1 jour