Skip to content

topoteretes/cognee / .agents/skills/docstring-author

docstring-author

Unverified

Write or improve Python docstrings on the ten files in pilot_files.md, making supported Cognee benefits and connections between capabilities explicit. Pass 1 of the docstring pilot; a separate critic verifies the patch and writes the claim ledger.

Docstring author

Shared rules

  • Edit only docstrings in the named target; the critic also writes the requested ledger. Leave code, imports, annotations, comments, other formatting, tests, and the allowlist unchanged. Stop if the prompt names no target.
  • The workflow validates the target against the ten-file allowlist and owns Git operations and the final diff check. Do not create commits or branches or perform Git writes.
  • Ground behavior and benefits in repository code or tests. Use CLAUDE.md and AGENTS.md for context, verifying behavioral claims in code. Other docstrings and selection notes are not evidence.
  • Published product docs in topoteretes/cognee-docs and at docs.cognee.ai are unavailable to these passes. Do not use unseen documentation as evidence.

1. Understand the task

Present the strongest truthful account of what this capability enables and how it works with the rest of Cognee. Readers, including agents using small models, may see only this docstring. Explain what they can build on, what Cognee connects or handles, and what they must provide. State supported strengths confidently: listing behaviors alone can leave their value invisible. A separate critic checks truthfulness and tone.

2. Inputs

Read the whole target, its row in pilot_files.md, and repository guidance. Establish value from code, including surrounding callers, implementations and tests; selection notes explain purpose, not evidence.

3. Investigation

  • Trace relevant inputs, outputs and choices into their consumers: what carries into ingestion, storage, retrieval or improvement, and why is that useful?
  • Identify work the shared flow handles, including for extensions. Verify whether each connection is automatic, requires configuration or registration, or is the caller's job.
  • Check outputs, setup, permissions, backend support and failures that affect using it.

4. Main work

  • Lead with the useful capability and its place in the wider flow. Explain the connection and its benefit. For example, when verified: "A registered custom retriever extends the standard search flow, so dataset access checks and database routing are already handled when search() invokes it." Examples guide wording, not evidence.
  • Explain public roles, meaningful choices, results and errors. For enums, explain when each option helps. Put relevant conditions beside benefits; let signatures carry obvious names and types. Avoid vague praise and unsupported comparisons or guarantees.
  • Rewrite repetition and incidental mechanics while preserving useful connections and caller obligations. Keep simple helpers simple. Match the existing docstring style and 100-character line limit. Leave private helpers alone unless their docstrings are wrong.

5. Quality check

Read as an agent seeing only this text: what does this enable, how does it fit, and what can I rely on or must I supply? Make those answers explicit and verify their evidence. Remove repeated explanations across module, class, method and parameter sections while retaining the brief context each needs. Confirm edits stay in scope.

6. Output

Leave edits in the target and print a brief summary of useful context added. Leave text unchanged when it already communicates the value accurately and concisely; explain why. Write no ledger: the workflow captures your patch for the independent critic.

receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 318kUpdated Claude CodeCodexUnverifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 318kUpdated Claude CodeCodexUnverifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 318kUpdated Claude CodeCodexUnverifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 318kUpdated Claude CodeCodexUnverifiedInstall