docs
Check that all code has appropriate documentation.
Arguments: $ARGUMENTS (optional scope)
- commit: Check only staged files
- pr: Check all files changed in the current PR
- all: Check the entire codebase
- If no argument provided:
- If in a PR branch: defaults to 'pr'
- Otherwise: defaults to 'commit'
Phase 1: Scope Determination
- Determine scope based on $ARGUMENTS
Phase 2: Documentation Analysis
- Identify functions/classes lacking documentation
- Check quality of existing documentation
- Extract project documentation standards from CLAUDE.md
Phase 3: Documentation Updates
-
For identified gaps:
- Generate documentation following project conventions
- Apply language-specific formats (roxygen2, docstrings, JSDoc)
- Use
@inheritParamsin R to avoid duplication
-
For R projects: Run
devtools::document()to update man/ files
Phase 4: Quality Verification
- Verify documentation format compliance and no broken references
Phase 5: Report Results
- Summary of files checked, documentation added/updated, and remaining issues
Auto-Exit When Standalone
IMPORTANT: If this command is being run as a standalone request, automatically exit after completing all phases successfully.
More from seabbs/skills
analyzing-research-papers
Expert methodology for analyzing and summarizing research papers, extracting key contributions, methodological details, and contextualizing findings. Use when reading papers from PDFs, DOIs, or URLs to create structured summaries for researchers.
229academic-writing-standards
Expert knowledge of academic writing standards for peer-reviewed papers, including citation integrity, style compliance, clarity, and scientific writing best practices. Use when reviewing or editing academic manuscripts, papers, or research documentation.
57taskfile-automation
Expert guidance for using Task (taskfile.dev) automation tool to discover and execute project development commands
18issue-reply
Post a helpful reply to a GitHub issue
8paper-summary
Summarise an academic paper from URL, DOI, or file path
7literature-search
Search local bibliography files and Paperpile for relevant papers
7