docstring

What the skill teaches

A contributor skill in the PyTorch repository that sets the house style for docstrings on PyTorch functions and methods, drawn from the tensor docs and the neural network functional module. Docstrings are raw strings in Sphinx reStructuredText with a signature line, a short description, math blocks and tensor shapes, cross-references, notes and warnings, an Args section with types and defaults, return values and examples with interpreter prompts. It explains how docstrings are attached to C-bound functions, tensor methods, in-place variants and aliases through PyTorch's own helpers, how to reuse shared argument text, and ends with a short checklist.

Capabilities

Details