docstring

Offizieller PyTorch-Leitfaden für präzise, konsistente und überprüfbare Docstrings.

Docstring ist ein offizieller Skill aus dem PyTorch-Repository. Er unterstützt Entwicklerinnen, Entwickler und technische Schreibende dabei, Funktions- und Methodendokumentation im Stil des PyTorch-Projekts zu verfassen oder zu überarbeiten. Laut Anbieter folgt der Skill den Konventionen aus zentralen PyTorch-Dateien wie torch/_tensor_docs.py und torch/nn/functional.py. Sein Zweck ist nicht, beliebige Produkttexte zu erzeugen, sondern technische Docstrings so zu strukturieren, dass Signatur, Verhalten, Parameter, Rückgabewerte, Beispiele und Verweise für Leserinnen und Leser sowie für die Dokumentationswerkzeuge des Projekts nachvollziehbar bleiben.

Zweck und Struktur

Der Leitfaden beginnt mit einer Signatur in der ersten Zeile. Sie soll Funktionsname, Positionsargumente, Schlüsselwortargumente, Standardwerte und Rückgabetyp zeigen und nicht mit einem Punkt enden. Darauf folgt eine kurze Beschreibung des Verhaltens. Je nach Funktion können mathematische Formeln mit den vorgesehenen Sphinx-Auszeichnungen, Querverweise zu Klassen, Funktionen, Methoden oder Attributen sowie Hinweise und Warnungen ergänzt werden. Die Quelle unterscheidet damit zwischen einer knappen Orientierung und den Details, die für eine belastbare API-Referenz nötig sind.

Parameter und Ergebnisse

Ein zentraler Teil des Skills ist die systematische Dokumentation aller Argumente. Parameternamen sollen kleingeschrieben werden, Typen gehören in Klammern und optionale Werte sollen ihren Standardwert nennen. Schlüsselwortargumente können in einem eigenen Abschnitt erscheinen, wenn das die Lesbarkeit erhöht. Rückgabewerte werden beschrieben, wenn ihre Form, ihr Datentyp oder ihre Semantik nicht bereits aus der Signatur hervorgeht. Diese Regeln helfen, implizite Annahmen sichtbar zu machen, etwa Formkonventionen von Tensoren, Verhalten bei bestimmten Datentypen oder die Wirkung eines Schalters.

Beispiele und Querverweise

Laut Anbieter sollen Beispiele verwendet werden, wann immer sie sinnvoll sind. Ein gutes Beispiel zeigt einen realistischen Aufruf und kann wichtige Varianten oder eine erwartete Ausgabe erläutern. Querverweise verbinden die Beschreibung mit verwandten PyTorch-Klassen und Funktionen. Dadurch entsteht keine isolierte Textinsel, sondern eine navigierbare Referenz. Bei mathematischen Operationen kann zusätzlich eine Formel die Implementierungsbeschreibung präzisieren. Der Skill behandelt native Python-Funktionen und C-gebundene Funktionen unterschiedlich: Bei letzterem Muster wird die Dokumentation über die vorgesehene Additionsfunktion an das gebundene Objekt angehängt.

Qualitätssicherung und Grenzen

Docstring ist ein Schreib- und Review-Leitfaden, kein automatischer Beweis für die Richtigkeit einer Implementierung. Vor der Veröffentlichung müssen Autorinnen und Autoren prüfen, ob Signatur, Code, Tests und tatsächliches Laufzeitverhalten übereinstimmen. Besonders wichtig sind optionale Argumente, Form- und Gerätetypen, Randfälle, Warnungen sowie Verweise auf umbenannte oder entfernte APIs. Der Skill legt Sphinx und reStructuredText nahe; die konkrete PyTorch-Version, der zuständige Dokumentationsbuild und lokale Projektregeln bleiben maßgeblich. Ein Modell kann plausible, aber falsche technische Aussagen formulieren, deshalb sollten Beispiele ausgeführt oder gegen Tests geprüft werden. Vertraulicher Quelltext sollte nur in einem ausdrücklich erlaubten Arbeitskontext verarbeitet werden.

Quelle und Einordnung

Die Primärquelle ist https://github.com/pytorch/pytorch/tree/main/.claude/skills/docstring. Ergänzend beschreibt die offizielle PyTorch-Dokumentation unter https://docs.pytorch.org/docs/stable/notes/doc.html die Dokumentationskonventionen des Projekts. PyTorch wird unter BSD-3-Clause veröffentlicht. Diese Beschreibung wurde am 9. September 2026 geprüft. GitHub-Sterne werden nicht gespeichert, weil das Skill-Modell kein github_stars-Feld besitzt. Der Skill ist für Claude Code ausgewiesen, da er im Verzeichnis .claude/skills liegt. Er ersetzt weder eine fachliche Prüfung noch die Tests und den Dokumentationsbuild des jeweiligen PyTorch-Arbeitsstands.

Installationsanleitung

Was ist die docstring Skill und wofür wird sie gebraucht

Die Skill mit dem Namen docstring liegt direkt im offiziellen PyTorch-Repository unter dem Pfad .claude/skills/docstring/SKILL.md und wird von Anthropic Claude Code automatisch erkannt, sobald man im PyTorch-Quellcode arbeitet. Eine Claude-Code-Skill ist im Kern eine Markdown-Datei mit klaren Anweisungen, die Claude beim Bearbeiten bestimmter Aufgaben zusätzlich lädt, ohne dass man diese Regeln bei jeder Anfrage erneut erklären muss. Im Fall von docstring geht es konkret um das Schreiben und Aktualisieren von Docstrings, also den Dokumentationstexten direkt im Quellcode von Funktionen und Methoden, die PyTorch-Entwicklerinnen und -Entwickler beim Verständnis einer API unterstützen. Die Skill orientiert sich laut den Quelldateien torch/_tensor_docs.py und torch/nn/functional.py an den internen Konventionen, die im PyTorch-Projekt seit Jahren gepflegt werden, und sorgt dafür, dass generierter Code stilistisch zur bestehenden Dokumentation passt. Für Laien lohnt sich der Hinweis, dass PyTorch eines der meistgenutzten Frameworks für maschinelles Lernen ist und eine konsistente Dokumentation dort direkten Einfluss auf die Lesbarkeit und die automatisch generierten Webseiten der offiziellen Dokumentation hat.

Schritt 1: Voraussetzungen

Um die Skill zu nutzen, braucht man eine lauffähige Installation von Claude Code sowie Zugriff auf den PyTorch-Quellcode, entweder über einen lokalen Klon des Repositorys pytorch/pytorch oder über ein eigenes Projekt, das dieselben Dokumentationskonventionen übernehmen möchte. Weil die Skill-Datei ein reines Textformat ohne ausführbare Abhängigkeiten ist, sind keine zusätzlichen Pakete, API-Schlüssel oder Berechtigungen notwendig. Wer die Konventionen in einem eigenen Projekt außerhalb von PyTorch verwenden will, sollte Grundkenntnisse in Sphinx und reStructuredText mitbringen, da genau dieses Format die Basis der Vorgaben bildet.

Schritt 2: Einrichtung Schritt für Schritt

Wer im offiziellen PyTorch-Repository arbeitet, muss nichts weiter tun: Claude Code liest Skills automatisch aus dem Verzeichnis .claude/skills und aktiviert die passende Skill, sobald die Aufgabe zum Schreiben oder Ändern eines Docstrings passt. Möchte man die Konventionen in einem eigenen Projekt nutzen, etwa für eine PyTorch-Erweiterung oder ein eng verwandtes Bibliotheksprojekt, kopiert man die Datei SKILL.md aus dem PyTorch-Repository in den eigenen Ordner .claude/skills/docstring und passt bei Bedarf den Namen sowie die Beschreibung im Kopfbereich an, damit Claude die Skill korrekt zuordnen kann. Anschließend erkennt Claude Code die Skill beim nächsten Start automatisch, ein Neustart des Tools ist in der Regel ausreichend.

Sicherheit und Best Practices

Da die Skill ausschließlich Formatierungs- und Stilregeln für Textdokumentation enthält und keinerlei Code ausführt, externe Netzwerkaufrufe tätigt oder auf Zugangsdaten zugreift, ist das Risiko bei der Nutzung sehr gering. Dennoch empfiehlt es sich, generierte Docstrings insbesondere bei mathematischen Formeln und Querverweisen auf andere Klassen oder Funktionen manuell zu überprüfen, weil fehlerhafte Sphinx-Direktiven erst beim Bauen der Dokumentation auffallen und dann zu gebrochenen Links oder falsch dargestellten Formeln führen können. Wer die Skill in einem eigenen Projekt anpasst, sollte zudem sicherstellen, dass die übernommenen Konventionen tatsächlich zum eigenen Dokumentationssystem passen, denn eine blinde Übernahme kann zu inkonsistenten Ergebnissen führen, wenn das Zielprojekt kein Sphinx verwendet.

Praxisbeispiel und Grenzen

Ein typisches Beispiel ist das Dokumentieren einer neuen Faltungsfunktion: Die Skill leitet Claude an, zunächst die vollständige Funktionssignatur mit Parametern und Rückgabetyp voranzustellen, danach eine knappe Beschreibung zu liefern, anschließend Parameter im Abschnitt Args mit Typangaben und Standardwerten aufzulisten und wo sinnvoll auf verwandte Klassen wie torch.nn.Conv2d zu verweisen. Die klare Grenze der Skill liegt darin, dass sie ausschließlich für den spezifischen reStructuredText-Stil von PyTorch entwickelt wurde und sich nicht ohne Anpassung auf andere verbreitete Docstring-Formate wie den Google-Stil oder den NumPy-Stil übertragen lässt. Wer außerhalb des PyTorch-Ökosystems arbeitet, sollte die Regeln daher als Vorlage verstehen, die vor dem Einsatz an die eigenen Konventionen angepasst werden muss, statt sie unverändert zu übernehmen.

Kostenlos
Anbieter
PyTorch
Lizenz
BSD-3-Clause
Zuletzt geprüft
09.09.2026

Repository und Dokumentation

Kategorien

Kompatibel mit

Claude Code