Results for “comments”

Refactors a Python script into a beginner-friendly project with clear comments and a complete markdown tutorial.

Ensure Java types are documented with Javadoc comments following best practices for documentation.

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.

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

Provides guidance on the history and correct usage of the em dash, enforcing a strict policy of never using em or en dashes in code or data files, and replacing them with hyphens. Also covers general punctuation rules for code comments.

Records architectural decisions and documentation to capture the context, constraints, and trade-offs behind codebase choices.

Structures a Request for Comments (RFC) document for proposing significant technical changes that require cross-team input and approval, guiding authors through problem definition, proposed solution, alternatives analysis, and rollout planning.