-
Notifications
You must be signed in to change notification settings - Fork 36
Resolves #44: --help text for pdd commands - output rich documentation #121
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Resolves #44: --help text for pdd commands - output rich documentation #121
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR transforms PDD command help output from brief one-liners to comprehensive man-page-style documentation. The implementation creates a new help content module and integrates it with the Click CLI framework to provide detailed command documentation accessible via --help flags.
Key Changes:
- Created centralized help content module with detailed documentation for 12 commands
- Added rich help formatting utilities with markdown rendering support
- Updated CLI command decorators to use new help content
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| pdd/rich_help.py | New module providing Rich-based help text formatting with markdown rendering and structured sections |
| pdd/help_content.py | New module containing comprehensive help documentation for all PDD commands |
| pdd/cli.py | Updated command decorators to reference help content from new module |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| from rich.panel import Panel | ||
| from rich.table import Table | ||
| from rich import box |
Copilot
AI
Nov 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unused imports detected: Panel, Table, and box from the rich library are imported but never used in this module. Consider removing these imports to keep the code clean and reduce unnecessary dependencies.
| from rich.panel import Panel | |
| from rich.table import Table | |
| from rich import box |
| pdd --force sync BASENAME | ||
|
|
Copilot
AI
Nov 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Duplicate example line: The command pdd --force sync BASENAME appears twice consecutively (lines 24 and 26) with no variation or explanation. Remove the duplicate line.
| pdd --force sync BASENAME |
|
locally passes unit tests haven't run regression/sync-regression target 11/10 |
closes #44
Summary
Transformed all PDD command --help output from brief one-liners into comprehensive, man-page-style documentation that provides complete reference information without leaving the terminal.
Commands Updated:
sync - Complete workflow orchestration
generate - Code generation from prompts
example - Create usage examples
test - Generate unit tests
fix - Fix errors in code and tests
update - Update prompts from code changes
preprocess - Process prompt directives
split - Split large prompts into modules
change - Modify prompts based on change requests
auto-deps - Automatic dependency analysis
verify - Functional correctness verification
crash - Fix runtime errors
Implementation Details
File Structure:
Created help_content.py - Centralized help content module
Modified cli.py - Updated command decorators to use rich help
Help Text Format:
Each command now follows this structure:
Quick Reference - Brief 1-2 line description at top
Usage - Command syntax with all options
Description - Detailed explanation of functionality
Arguments - Parameter descriptions
Examples - Real-world usage scenarios with actual commands
See Also - Cross-references to related commands
Technical Considerations:
Used Click's \b escape sequences to prevent automatic text wrapping
Avoided Markdown syntax (Click doesn't render it in terminals)
Added \b markers between each bullet point for proper line separation
Used $ prefix for shell commands (standard convention)
Proper indentation for readability
Testing
Verified all 12 commands display help without errors
Confirmed formatting displays correctly in terminal (no text wrapping issues)
Tested bullet point separation (each on own line)
Validated cross-references are accurate