Writes and converts Google-style Python docstrings compliant with ruff D and DOC rules.
npx skills add https://github.com/bsamiee/Rasm --skill python-document-bsamiee
Please help me install this Agent Skill. Skill: python-document Source: https://github.com/bsamiee/Rasm/tree/main/.claude/skills/python-document Command: npx skills add https://github.com/bsamiee/Rasm --skill python-document-bsamiee
:param: fields and NumPy-style docstrings into Google sections while preserving existing content. - Rule Compliance: Satisfies ruff D100-D421 and DOC201-DOC502 checks, including one-liner formatting, inline attribute docstrings for dataclasses and Pydantic models, and exemptions for tests and typing.override. - Use Case: When ruff reports a D417 missing-argument or DOC501 missing-raises violation, use this Skill to produce a compliant docstring that passes lint on the next run. ## Quick Start Fix the ruff D and DOC violations in this Python file by writing Google-style docstrings for every public function and class.High-intent search queries and answers about installing and using this skill.
Start with a one-sentence summary ending in a period, then add capitalized sections in order: Args, Returns or Yields, then Raises. Indent entries four spaces and omit type annotations since type hints already state the types.
Add an Args section listing every function parameter with a description, excluding self, cls, *args, and **kwargs. Each entry uses the format name followed by a colon and description, indented four spaces from the header.
Ruff D101 to D103 rules are disabled for test files through per-file ignores, so test classes, methods, and functions need no docstrings. The module docstring at the top of the test file is still required.
Dataclasses, Pydantic models, TypedDicts, and NamedTuples use inline string literals on the line after each field, the PEP 257 attribute docstring form. The class docstring itself contains no Attributes section for those fields.
Use a one-liner when the docstring needs no sections, with opening and closing quotes on one line and no blank lines around it. Ruff skips DOC rules for one-line docstrings when ignore-one-line-docstrings is enabled.
DOC501 fires when the function body contains a raise statement but the docstring lacks a matching Raises entry. List every raised exception except NotImplementedError with a condition describing when it occurs.
Unique-AGAutomate Python linting and formatting with Ruff auto-fixes.
UnsupervisedcomFormat and lint Python code with ruff after tests pass.
Arete-ConsortiumAdds inferred type hints to untyped Python code and validates them with mypy.
HomericIntelligenceGenerates API reference documentation from Python docstrings using pdoc or Sphinx.