Generate PyTorch-style docstrings for Python functions and methods.
npx skills add https://github.com/nilecui/SkillsBase --skill docstring-nilecui
Please help me install this Agent Skill. Skill: docstring Source: https://github.com/nilecui/SkillsBase/tree/main/.cursor/skills/docstring Command: npx skills add https://github.com/nilecui/SkillsBase --skill docstring-nilecui
This Skill helps developers write high-quality, consistent docstrings for PyTorch functions and methods, adhering to project conventions and best practices.
Write a docstring for the torch.nn.functional.conv2d function following PyTorch conventions.
High-intent search queries and answers about installing and using this skill.
To write PyTorch docstrings, generate standardized documentation using Sphinx and reStructuredText formatting. This ensures adherence to project conventions by covering function signatures, parameter descriptions, mathematical formulas, cross-references, and examples.
Documenting mathematical formulas in Python docstrings requires using raw strings and reStructuredText syntax. This approach aligns with PyTorch project conventions, ensuring complex equations and function signatures render correctly in Sphinx-generated documentation.
Formatting function signatures and parameter descriptions for a PyTorch custom layer involves applying specific reStructuredText patterns. This generates comprehensive guidance covering arguments, return types, notes, warnings, and examples.
Yes, this docstring generation approach works for both Python functions and class methods within the PyTorch ecosystem. It applies project-specific Sphinx formatting rules to ensure consistent documentation across different code structures.
You need to use cross-references in reST docstrings when linking related PyTorch functions, classes, or modules. This ensures developers can navigate interconnected APIs seamlessly within the Sphinx documentation build.
PyTorch docstrings fail to render correctly in Sphinx when they deviate from expected reStructuredText conventions. Ensuring raw strings, proper parameter formatting, and PyTorch-specific patterns are used resolves generation and rendering issues.
mvillmowGenerate HTML or Markdown API reference docs from docstrings.
ricardorocheEnforce Google-style docstrings for Python functions and classes.
gouravsingh311Enforce static typing with annotations, generics, and protocols via mypy or pyright.
jah377Format Python docstrings to the Google style guide.
