Skip to content
TrustedSkillsbeta
Back to all skills

Docstring

Official
pytorch·vlatest·writing

Generates comprehensive docstrings for Python code, improving readability and facilitating automated documentation generation.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add pytorch/pytorch --skill docstring -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

pytorch

Matched to the vendor's own GitHub organisation.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Makes no network calls.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned pytorch/pytorch at edd4fc2d34.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
edd4fc2d34
Manifest
.claude/skills/docstring/SKILL.md
Scanned
1 file, 324 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

This skill provides access to documentation strings (docstrings) associated with Python code. It can extract and present these docstrings, offering explanations of functions, classes, modules, and methods directly within an AI agent's workflow. This allows for on-demand understanding of code functionality without needing to consult external documentation sources.

When to use it

  • Debugging: Quickly understand the purpose and parameters of a function during troubleshooting.
  • Learning new libraries: Explore the capabilities of unfamiliar Python packages by examining their docstrings.
  • Code generation assistance: Use docstring information to guide the creation of new code snippets or functions.
  • API integration: Understand how to use specific API calls and methods through their associated documentation.

Key capabilities

  • Retrieves docstrings from Python objects (functions, classes, modules).
  • Provides explanations of object parameters and return values.
  • Supports various levels of detail in the retrieved information.

Example prompts

  • "Show me the docstring for torch.Tensor."
  • "What does the backward() method do?"
  • "Explain the purpose of the nn.Linear class."

Tips & gotchas

  • The skill relies on valid Python code being available to extract docstrings from. It may not work with incomplete or syntactically incorrect code.