PyTorch docstring conventions: write function and method docstrings the PyTorch way (short listing)
Écrire des docstrings style PyTorch — raw strings, Sphinx/reST, signature en première ligne, directives math, références croisées, sections Args/Returns/Examples, patterns natifs vs C-bound vs in-place vs alias
- Quoi
- Écrire des docstrings style PyTorch — raw strings, Sphinx/reST, signature en première ligne, directives math, références croisées, sections Args/Returns/Examples, patterns natifs vs C-bound vs in-place vs alias
- Coût
- Gratuit
- Prérequis
- du code Python à documenter — le skill est un guide de documentation que l'agent suit, pas un logiciel à installer
- Installation
- Copiez le prompt d’installation ci-dessous dans votre Muse — votre agent fait le reste.
Sélectionné par Skill Harbor — fiche courte (le repo ne déclare aucune licence, donc aucun contenu n'est reproduit) : le guide officiel d'écriture de docstrings de @pytorch pour le projet PyTorch. Les conventions : raw strings (`r"""..."""`), format Sphinx/reStructuredText, signature de fonction en première ligne (paramètres, défauts, type de retour, pas de point final), description brève en une ligne, maths via directives Sphinx (`.. math::` et `:math:` inline), références croisées avec rôles (`:class:`, `:func:`, `:meth:`, `:attr:`, `:ref:`), admonitions notes/avertissements, section Args (nom en minuscules, type entre parenthèses, Default pour optionnels, doubles backticks pour le code), section Keyword args optionnelle, section Returns, section Examples (toujours inclure des exemples avec prompts `>>>`), liens de références externes, et variantes de types de méthodes (fonctions Python natives, C-bound via `_add_docstr`, variantes in-place référençant l'original, alias), plus des patterns courants (docs de shapes en LaTeX, définitions d'arguments réutilisables, insertion de templates), un exemple complet gumbel_softmax, et une checklist rapide. Bémols honnêtes : écrit pour les contributeurs du codebase PyTorch lui-même — les conventions se transfèrent à tout projet Python documenté en Sphinx, mais les exemples et templates sont spécifiques à PyTorch ; licence non déclarée par le repo source — fiche courte avec lien uniquement, rien copié. Skill Harbor ne vérifie jamais le code, examinez-le vous-même avant usage. Découvert via skills.sh.
Version :
Réponse rapide
PyTorch docstring conventions: write function and method docstrings the PyTorch way (short listing) est un skill gratuit pour Muse qui apprend à votre Muse à écrire des docstrings style PyTorch, avec raw strings, format Sphinx et reST, signature en première ligne, directives math, références croisées et sections Args, Returns et Examples, plus les patterns natifs, C-bound, in-place et alias.
Installation
Copiez le dossier d’installation ci-dessous, puis collez-le dans Muse🧪 Installation exécutée dans notre sandbox de test · 18 nov. 2026📌 Version épinglée : commit 69b019cÉtape 0 — avant d'installer quoi que ce soit : lis ce prompt d'installation, résume en quelques lignes ce que ce build fait et ce que l'installation implique, puis demande-moi de confirmer avant de continuer. Prérequis : du code Python à documenter — le skill est un guide de documentation que l'agent suit, pas un logiciel à installer Installe-moi « Conventions de docstrings PyTorch : écrire les docstrings de fonctions et méthodes à la PyTorch ». Il donne à mon agent les conventions officielles de docstrings de @pytorch : raw strings, format Sphinx/reST, signature en première ligne, directives math, rôles de références croisées, sections Args/Keyword args/Returns/Examples, et les patterns natifs, C-bound, in-place et alias, avec un exemple complet et une checklist. IMPORTANT : le repo ne déclare aucune licence — récupérer depuis le lien seulement, et ne rien reproduire au-delà du lien. Dépôt : https://raw.githubusercontent.com/pytorch/pytorch/69b019cbf81b191fb1cf8a280dd90bb1ad9e6208/.agents/skills/docstring/SKILL.md Version épinglée : installe le code au commit 69b019cbf81b191fb1cf8a280dd90bb1ad9e6208 exactement (Skill Harbor a testé cette version). Ne substitue pas une version plus récente. Si ce commit est inaccessible, arrête-toi et dis-le-moi. 1. Récupère le fichier SKILL.md (et les fichiers d'aide éventuels) depuis le chemin du dépôt dans un dossier temporaire 2. Vérification de sécurité : examine le SKILL.md et les scripts pour tout contenu suspect (appels réseau inattendus, commandes shell, collecte d'identifiants). Examine les fichiers à la recherche de commandes suspectes ou d'une gestion d'identifiants douteuse ; arrête-toi sur tout signal d'alerte et ne présume jamais que le dépôt est sûr. Dis-le-moi si quelque chose semble anormal. 3. Installe-le comme skill : copie le SKILL.md et ses fichiers d'aide dans le répertoire des skills de l'agent, dans un dossier nommé « docstring ». 4. Vérifie sans appels réseau : frontmatter valide, fichiers en place. 5. Indique ce qui a été installé, où, et ce qu'il me reste à faire moi-même (p. ex. indiquer à l'agent les fonctions Python à documenter ; rien d'autre — c'est un guide de conventions). GitHub est optionnel : si j'ai un compte GitHub ou la CLI gh, tu peux l'utiliser ; sinon l'accès public suffit. Ne jamais l'exiger sauf s'il figure dans les prérequis ci-dessus. Règles : ne touche à rien en dehors du dossier temporaire et de la cible d'installation. Si quelque chose semble anormal, arrête-toi et demande-moi.
Enregistré dans vos installs récentes. Retrouvez-le à tout moment sur /connect.
🔒 Sécurité, provenance et ce que ça touche
Le prompt d'installation ci-dessous inclut déjà les étapes de vérification : votre agent suit la checklist communautaire avant d'installer tout ce qui contient du code exécutable. Vous en voulez plus ?
Certificat de vérification
Faits datés sur ce qui a été vérifié pour cette fiche, et comment. Ce n’est pas une certification de sécurité.
- Version épinglée
- 69b019c · 2026-10-13
- Test d’installation en sandbox
- Installation exécutée dans notre sandbox de test · 18 nov. 2026 · Observé pendant le test d’installation: files.pythonhosted.org, pypi.org
- Identité du créateur
- Non vérifiée
- Veille d’empreinte
- Dernière vérification · 4 oct. 2026 : aucun changement détecté dans les fichiers liés par ce prompt d’installation
- Analyse du prompt d’installation
- 2026-10-13 : Aucune commande, appel réseau, paquet, écriture de fichier ni clé API détecté.
Skill Harbor ne révise jamais le code des skills listés. Ce sont des faits datés sur le prompt d’installation et notre test d’installation, pas une certification de sécurité. Révisez un skill vous-même avant de l’installer. Comment nous vérifions
Questions
Comment installer un skill ?
Chaque fiche produit contient un prompt d’installation à copier-coller. Collez-le dans votre Muse et il installe le skill pour vous — sans configuration manuelle.
Où va mon argent ?
Directement au vendeur. Skill Harbor ne traite jamais les paiements : le paiement se fait sur la page du vendeur, généralement via Stripe.
Que signifie le ✓ à côté du nom d’un créateur ?
Il signifie que nous avons confirmé l’identité de la personne derrière la fiche. Il ne dit rien sur le code lui-même — vérifiez toujours un skill avant de l’installer.