Skip to content

Commit 12b328a

Browse files
sjnimsclaude
andauthored
chore(docs): remove false-positive TODOs from example documentation (#52)
## Summary Removes `TODO:` prefixes from example documentation to prevent the weekly maintenance workflow from flagging them as action items. ## Problem Fixes #51 The weekly maintenance report flagged 3 TODOs in `documentation-patterns.md`, but these were actually part of an example command specification template showing what a "FUTURE IMPROVEMENTS" section might look like—not real action items for the codebase. ## Solution Removed the `TODO:` prefixes while preserving the FUTURE IMPROVEMENTS section content. This maintains the documentation's purpose (showing a pattern) without triggering false positives in maintenance scans. ### Alternatives Considered 1. **Create issues for the features** - Not appropriate since these are hypothetical examples, not planned features 2. **Exclude the file from TODO scanning** - Would be overly broad and might miss real TODOs 3. **Change to "Planned:" prefix** - Simpler to just remove the prefix entirely ## Changes - `plugins/plugin-dev/skills/command-development/references/documentation-patterns.md`: Removed `TODO:` prefixes from 3 example items ## Testing - [x] Verified no TODOs remain in the file - [x] Linting passes --- 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <noreply@anthropic.com>
1 parent 254b168 commit 12b328a

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

plugins/plugin-dev/skills/command-development/references/documentation-patterns.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -587,9 +587,9 @@ TESTING:
587587
- Manual test checklist: tests/manual-checklist.md
588588
589589
FUTURE IMPROVEMENTS:
590-
- TODO: Add support for TOML format
591-
- TODO: Implement parallel processing
592-
- TODO: Add progress bar for large files
590+
- Add support for TOML format
591+
- Implement parallel processing
592+
- Add progress bar for large files
593593
594594
RELATED FILES:
595595
- lib/parser.sh: Shared parsing logic

0 commit comments

Comments
 (0)