ds-notebook-readability

What problem does it solve?

Analytical notebooks often become hard to review or reuse because the reader cannot tell why each step exists, which assumptions were made, or what output drives later conclusions.

Core Features & Use Cases

• Comment analytical intent: Add concise markdown notes, docstrings, or block comments that explain non-obvious choices, assumptions, and decision logic without restating syntax.
• Improve notebook handoff readiness: Perform a “handoff pass” over long cells, metric/label/model/diagnostic sections, transformations, joins, aggregations, and export/narrative steps to ensure a new analyst can interpret results.
• Target explanations only where needed: Explain inputs, grains/denominators, edge cases, authoritative outputs, and interpretation boundaries so correctness and intent are visible to reviewers.

Quick Start

Use ds-notebook-readability when you are editing or reviewing a notebook and want to add the minimum necessary explanations so another analyst can understand the methodology, assumptions, and decision logic.