docstring

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.