Results for “commenting”

Use when writing or editing a code comment or a documentation block, and when reviewing the comments and documentation in a diff before presenting it. Decides what stays in the source, what moves to reference documentation, and what gets deleted.

Resolves an approved article comment task into a publishable AI markdown reply by fetching article context from a local HTTP API (with sf-cli fallback), reasoning with the selected quote and full article content, and writing the final reply to a backend-provided local result file path.

Writing effective project documentation — READMEs, API doc comments, and inline comments that explain why. Use when writing or improving documentation — READMEs, doc comments, inline comments, or when code lacks explanation for non-obvious behavior.

Transform code files into learning resources by adding educational comments that explain syntax, idioms, and design choices.

Write, review, and improve blog posts for the Sentry engineering blog following Sentry's specific writing standards, voice, and quality bar.

Ensure C# types are documented with XML comments following best practices for summaries, parameters, returns, and exceptions.

Use to write CX commentary that makes a number decision-ready — what moved, why (decomposed), so what, do what — separating noise from signal and stating confidence honestly. Trigger for "write the commentary", "explain this trend", "what should we say about the drop", weekly or monthly narrative, board pack prose, "why did QA fall", metric movement write-up, or when a report has charts but no story.

Code comment accuracy verification, documentation completeness assessment, comment rot detection.