Write PyTorch function and method docstrings in reST format.
npx skills add https://github.com/teddytennant/rusttorch --skill docstring-teddytennant
Please help me install this Agent Skill. Skill: docstring Source: https://github.com/teddytennant/rusttorch/tree/main/.claude/skills/docstring Command: npx skills add https://github.com/teddytennant/rusttorch --skill docstring-teddytennant
Docstring writing for PyTorch functions and methods is repetitive and error-prone. This skill standardizes the recommended structure, formatting, and references to speed up documentation tasks and improve clarity.
Provide a docstring example for a PyTorch function such as conv2d(input, weight, bias=None, stride=1, padding=0, dilation=1, groups=1) -> Tensor
High-intent search queries and answers about installing and using this skill.
PyTorch docstrings follow reStructuredText format with a signature line, concise description, Args/Returns sections, cross-references, and a working example. This standardized structure ensures consistency across the codebase and improves clarity for users reading function documentation.
PyTorch docstrings use raw strings with Sphinx-compatible reStructuredText syntax, including backtick cross-references, parameter documentation, return type specifications, notes/warnings sections, and executable code examples demonstrating expected behavior.
Yes, PyTorch docstrings require reStructuredText formatting for Sphinx compatibility. This includes backticks for code references, consistent indentation, parameter role markup, and proper section headers to generate accurate API documentation.
Examples in PyTorch docstrings demonstrate correct usage patterns and expected output, reducing user confusion and supporting Sphinx documentation generation. Clear examples accelerate developer onboarding and reduce support burden.
A complete PyTorch docstring includes: signature line, description, Args section for parameters, Keyword args if applicable, Returns section with type, and Examples demonstrating usage. Optional Notes and Warnings sections address edge cases and precautions.
Follow PyTorch's standardized conventions: use raw strings, enforce consistent indentation, apply backtick formatting for cross-references, document all parameters and return types, and include working examples. This consistency improves maintainability and documentation quality.
ORANGECRAB13Generate Google-style docstrings for Python modules and classes.
CHENyiru3Generate Google-style docstrings, Sphinx configuration, and ReadTheDocs-ready documentation templates.
HomericIntelligenceGenerates API reference documentation from Python docstrings using pdoc or Sphinx.
jah377Format Python docstrings to the Google style guide.
