Skills Guide

Assistant Docstring Google

VérifiéSûr

Rédigez des docstrings Python en suivant le Guide de style Google, avec des sections claires et des exemples.

Télécharger et utiliser
Spar Skills Guide Bot
DocumentationDébutant
22/07/2026
Claude CodeCursorWindsurfCopilotCodex
#python#docstrings#google-style#code-documentation#style-guide

Recommandé pour

Développeur backendClaude CodeCursorCopilotDocumentation automatiqueWindsurf

Synthèse automatique

Rédige des docstrings Python conformes au Google Python Style Guide, avec des sections claires et des exemples.

Points forts

  • Impose une structure par sections comme Args, Returns, Raises, Attributes et Todo
  • Évite de répéter les types déjà présents dans les annotations lorsque ce n'est pas utile
  • Explique comment intégrer des blocs d'exemples littéraux pour le code ou les commandes
  • Couvre les docstrings de fonctions, modules et classes

Limites

  • Ne traite que le style Google, pas les formats NumPy ou Sphinx
  • Ne vérifie ni ne reformate automatiquement les docstrings
  • S'appuie sur un fichier de référence externe pour les règles complètes
Quand l'utiliser

À utiliser lorsqu'on écrit ou révise des docstrings Python devant suivre le Google Python Style Guide.

Quand l'éviter

À éviter si le projet impose un autre format de docstring ou nécessite une validation automatique par un linter.

Analyse de sécurité

Sûr
Score qualité88/100

The skill provides instructions for writing Python docstrings according to the Google Python Style Guide. It declares no tools and contains no executable commands, destructive actions, network access, or data exfiltration. There is no meaningful execution risk.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Function docstring with Args, Returns, and Raises
Write a Google-style docstring for this Python function, including Args, Returns, and Raises sections:

def parse_config(path):
    ...
Module docstring with Attributes and Todo
Add a Google-style module docstring for this file. Include an Attributes section for the module-level constants and a Todo section for the unfinished caching work.
Convert to Google style with Examples
Convert this existing Python docstring to Google style, keep it concise, and add an Examples section with an indented literal block showing a sample call.

name: google-docstring-assistant description: Write Python docstrings following the Google Python Style Guide, using clear sections and examples.

Google Docstring Assistant

Quick start

  • Write docstrings using the Google Python Style Guide structure (Args, Returns, Raises, Examples, Attributes, etc.).
  • Keep sections as headers followed by indented blocks; break sections by resuming unindented text.
  • When types are annotated in code, omit them in docstrings unless clarity is improved.
  • Use Examples blocks with literal blocks (::) for commands or code snippets.
  • Document module-level variables consistently (all in Attributes or inline), and list TODOs in a Todo section.
  • See references/google_docstring_rules.md for full guidance and examples.

Workflow

  1. Choose sections

    • Functions: include Args, Returns, and Raises as needed.
    • Modules/classes: use Attributes and Todo when relevant; keep formatting consistent.

  2. Write clearly

    • One docstring per object; keep it concise and informative.
    • Use indentation under each section header; separate sections by returning to unindented text.
    • Prefer Google-style wording; avoid duplicating annotated types unless helpful.

  3. Examples and scripts

    • Use Examples: with indented literal blocks for shell commands or code snippets.
    • Include multi-line descriptions when needed; keep formatting readable.

Reference

  • references/google_docstring_rules.md: full style description and examples.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/google-docstring-assistant-mrwak8tn' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/google-docstring-assistant-mrwak8tn/download' --output '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md.part' && mv '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md.part' '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md' && test -s '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/google-docstring-assistant' && cp -R '.skill-downloads/google-docstring-assistant-mrwak8tn' '.claude/skills/google-docstring-assistant'

Cursor
test -f '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md' && test -s '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/google-docstring-assistant' && cp -R '.skill-downloads/google-docstring-assistant-mrwak8tn' '.cursor/skills/google-docstring-assistant'

Codex
test -f '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md' && test -s '.skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/google-docstring-assistant' && cp -R '.skill-downloads/google-docstring-assistant-mrwak8tn' '.agents/skills/google-docstring-assistant'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/google-docstring-assistant-mrwak8tn'

openskills read 'google-docstring-assistant-mrwak8tn'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/google-docstring-assistant-mrwak8tn/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires

Rédaction de docs Supabase

Documentation

Rédigez, éditez et révisez le contenu de la documentation Supabase : guides, tutoriels, références et partiels. Suivez les guides de style et les règles de validation MDX/TOML.

Claude CodeintermediateSûr 108,544
Skills Guide Bot

Créer un enregistrement de décision d'architecture

Documentation

Créer un nouveau ADR avec numérotation séquentielle, l'enregistrer dans le graphe AgentDB et le lier aux ADR associés.

Claude CodeintermediateSûr 69,659
Skills Guide Bot

Mise à jour de plan avec recherche approfondie

Documentation

Met à jour un document de plan en lançant des sous-agents en parallèle pour analyser un sujet sur tous les passes du compilateur, puis consolide les résultats.

Claude CodeadvancedSûr 248,015
Skills Guide Bot