Generate PyTorch-style docstrings with Args, Returns, Examples sections.
npx skills add https://github.com/pytorch/pytorch --skill docstring
Please help me install this Agent Skill. Skill: docstring Source: https://github.com/pytorch/pytorch/tree/main/.claude/skills/docstring Command: npx skills add https://github.com/pytorch/pytorch --skill docstring
This Skill streamlines the process of writing and updating docstrings for PyTorch functions and methods, ensuring they adhere to official PyTorch conventions. It eliminates the guesswork and manual effort involved in formatting, parameter documentation, and example inclusion, allowing developers to focus on code logic rather than documentation syntax.
Args, Keyword Args, Returns, and Examples sections.Write a docstring for a new PyTorch function my_new_function(input: Tensor, value: float) -> Tensor that applies a custom activation.
High-intent search queries and answers about installing and using this skill.
PyTorch-style docstrings use reStructuredText syntax with raw strings and follow a structured format: function signature, brief description, mathematical formulas, cross-references, Args, Keyword Args, Returns, and Examples sections. This Skill automates generation to ensure compliance with PyTorch conventions from torch/_tensor_docs.py and torch/nn/functional.py, eliminating manual formatting effort and review cycles.
A complete PyTorch docstring requires: function signature line, brief description, mathematical formulas when applicable, cross-references, notes and warnings, Args, Keyword Args, Returns, and Examples. This Skill ensures all required sections are present, correctly formatted in reStructuredText, and consistent across your codebase.
Yes. This Skill generates compliant docstring templates for new or existing PyTorch functions and methods by applying official PyTorch conventions. Provide the function signature and parameters; the Skill produces a structured template with Args, Returns, Examples, and all required sections ready for customization.
PyTorch uses Sphinx-compatible reStructuredText (reST) format with raw strings for docstrings. This Skill handles reST syntax, cross-reference markup, code examples, and parameter formatting automatically, ensuring docstrings integrate seamlessly with Sphinx documentation generation and match PyTorch's official style.
Automated docstring generation eliminates guesswork in formatting, parameter documentation, and example inclusion, allowing developers to focus on code logic. By generating compliant templates with all required sections pre-structured, this Skill significantly reduces review cycles and standardization effort across teams.
No. This Skill handles reStructuredText formatting and Sphinx conventions automatically. You provide function signatures and parameters; the Skill generates properly formatted docstrings with correct reST syntax, cross-references, and section structure without requiring manual syntax knowledge.
ORANGECRAB13Generate Google-style docstrings for Python modules and classes.
HomericIntelligenceGenerates API reference documentation from Python docstrings using pdoc or Sphinx.
phenobarbitalAutomate Python tooling standards using uv, pytest, ruff, and basedpyright.
michsindlingerGenerates inline comments, docstrings, type hints, and annotations for Ruby, JavaScript/TypeScript, and Python code.