Generate PyTorch docstrings with reST formatting and cross-references.
npx skills add https://github.com/steleman/pytorch-cuda-2.11.0 --skill docstring-steleman
Please help me install this Agent Skill. Skill: docstring Source: https://github.com/steleman/pytorch-cuda-2.11.0/tree/main/.claude/skills/docstring Command: npx skills add https://github.com/steleman/pytorch-cuda-2.11.0 --skill docstring-steleman
This guide helps contributors write clear, correct docstrings for PyTorch functions and methods, following PyTorch conventions.
Follow this guide to draft a PyTorch docstring that includes the function signature, a brief description, an Args section, a Returns section, and an Examples block.
High-intent search queries and answers about installing and using this skill.
Write PyTorch docstrings using raw string formatting (r"""..."""), reStructuredText syntax, and cross-references. Structure them with function signatures, Args, Returns, and Examples sections to match conventions in torch/_tensor_docs.py and torch/nn/functional.py.
The correct format for PyTorch docstrings uses reStructuredText (reST) syntax for Args and Returns sections. Arguments should be listed with their types and descriptions, ensuring raw strings are used consistently throughout the documentation block.
Add cross-references in PyTorch API documentation by using reStructuredText (reST) formatting syntax. This ensures related classes and functions are linked correctly within the generated Sphinx API reference documentation.
This guide is specifically for PyTorch codebases, applying conventions from torch/_tensor_docs.py and torch/nn/functional.py. While the reST and raw string formatting principles apply generally, the structure targets PyTorch's API reference standards.
PyTorch docstrings require raw strings (r"""...""") to prevent escape sequence interpretation. This ensures reStructuredText (reST) formatting, cross-references, and code examples remain intact without character corruption during Sphinx documentation generation.
The best way to generate PyTorch API reference documentation is to write well-structured docstrings using reST syntax, including function signatures, Args, Returns, and Examples. This ensures high-quality, readable output when processed by Sphinx.
lexicalninjaGenerate docstrings, comments, and API documentation for Python, JavaScript/TypeScript, Go, and Java projects.
mvillmowGenerate HTML or Markdown API reference docs from docstrings.
nilecuiGenerate PyTorch-style docstrings for Python functions and methods.
Thanhhuong0209Enforce Google-style docstring conventions for Python code.
