Generates PyTorch-style docstrings with Args, Returns, and Examples.
npx skills add https://github.com/biobenkj/flash-semicrf --skill docstring-biobenkj
Please help me install this Agent Skill. Skill: docstring Source: https://github.com/biobenkj/flash-semicrf/tree/main/.claude/skills/docstring Command: npx skills add https://github.com/biobenkj/flash-semicrf --skill docstring-biobenkj
Automates the creation of PyTorch-style docstrings for functions and methods, ensuring consistent documentation across a codebase and reducing manual drafting time.
Create a PyTorch-style docstring for a function by providing its signature and core parameters, following the guide to structure Args, Returns, and Examples.
High-intent search queries and answers about installing and using this skill.
To generate PyTorch-style docstrings for custom modules, provide the function signature and parameters to produce reStructuredText formatted documentation with raw-string code blocks and cross-references. This enforces project conventions for Args, Returns, and Examples sections automatically.
The correct format for PyTorch API documentation is reStructuredText style, featuring raw-string formatting for code blocks, cross-references, and structured Args, Returns, Notes, and Examples sections. This ensures consistent, high-quality API docs across PyTorch and custom modules.
Yes, this docstring generator supports reStructuredText cross-references. It enforces raw-string formatting for code blocks and applies cross-references to ensure consistent PyTorch-style API documentation across functions and methods.
Yes, you can automate API documentation generation during a codebase refactor by applying guided templates to function signatures. This quickly generates consistent PyTorch-style docstrings, reducing manual drafting time and ensuring uniform reStructuredText formatting.
The best way to write consistent docstrings for PyTorch utilities is to use guided templates that conform to PyTorch conventions. This approach enforces raw-string formatting, reStructuredText style, and proper Args and Returns sections across the entire codebase.
PyTorch docstring code block formatting often breaks without raw-string formatting. This generator enforces raw-strings for code blocks and reStructuredText style, preventing formatting issues and ensuring cross-references render correctly in API documentation.
nilecuiGenerate PyTorch-style docstrings for Python functions and methods.
HomericIntelligenceGenerates API reference documentation from Python docstrings using pdoc or Sphinx.
softsparkDetect and execute linters and type checkers for Python, JavaScript, PHP, Go, Dart, and Rust projects.
mvillmowGenerate structured docstrings for functions and classes in Google, NumPy, and reStructuredText formats.
