explain-func

Generate why-focused docstrings by documenting purpose, design decisions, invariants, and trade-offs rather than line-by-line behavior. This approach captures rationale and constraints, improving maintainability and reducing onboarding time for complex logic.

Documenting code invariants involves explicitly stating design choices, performance considerations, and compatibility constraints in a documentation header. This clarifies non-obvious trade-offs and helps future contributors understand expected behavior and risks without altering runtime logic.

Yes, you can generate documentation for functions, algorithms, and code blocks across languages where reviewers need rationale. The Skill produces a docstring or documentation header containing purpose, parameters, return values, and exceptional cases regardless of language.

Create maintainable code documentation by generating concise, why-focused docstrings that explain purpose, reasoning, and constraints. This guidance helps future contributors understand intent, risks, and expected behavior, significantly reducing onboarding time for complex logic.

No, generating why-focused documentation does not alter runtime logic. The process produces a docstring or documentation header containing purpose, parameters, return value, and exceptional cases without changing the underlying code behavior.

You need to document design decisions and rationale when code contains non-obvious design choices, invariants, or performance and compatibility considerations. Capturing this intent reduces onboarding time and improves maintainability for complex algorithms and functions.