Skip to content
TrustedSkillsbeta
Back to all skills

Documenting Python Libraries

Checked
wdm0006·vlatest·backend·MIT

Automatically generates comprehensive documentation strings for Python libraries, improving code clarity and maintainability.

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 wdm0006/python-skills --skill documenting-python-libraries -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

wdm0006

Taken from the source listing. We haven't verified who controls this account.

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 wdm0006/python-skills at 954796b7fc.

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

Commit
954796b7fc
Manifest
skills/python/documentation/SKILL.md
Scanned
3 files, 379 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 automatically generates documentation for Python libraries. It analyzes the library's code and docstrings to produce structured documentation in a standard format, such as reStructuredText or Markdown. The resulting documentation can be used to create API references, tutorials, and other developer resources.

When to use it

  • Creating initial documentation: Quickly generate basic documentation for a new Python library project.
  • Updating existing documentation: Automatically update documentation when the library's code changes.
  • Generating API reference: Produce comprehensive API documentation from docstrings.
  • Documenting open-source projects: Help maintainers of open-source libraries keep their documentation up to date.

Key capabilities

  • Code analysis
  • Docstring parsing
  • Documentation generation (reStructuredText, Markdown)
  • API reference creation

Example prompts

  • "Generate documentation for the 'requests' library."
  • "Create an API reference for my 'my_library' project in Markdown format."
  • "Update the documentation for the 'utils' module in my project."

Tips & gotchas

The quality of the generated documentation depends heavily on the quality and completeness of the Python library’s docstrings. Ensure your code has well-written docstrings to maximize the effectiveness of this skill.