Skip to content

Conversation

@qanagattandyr
Copy link
Contributor

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

@qanagattandyr qanagattandyr marked this pull request as ready for review November 9, 2025 21:45
@qanagattandyr qanagattandyr changed the title Enhanced --help Documentation for All PDD Commands resolves #44: --help text for pdd commands - output rich documentation Nov 9, 2025
@qanagattandyr qanagattandyr changed the title resolves #44: --help text for pdd commands - output rich documentation Resolves #44: --help text for pdd commands - output rich documentation Nov 9, 2025
@gltanaka gltanaka requested a review from Copilot November 10, 2025 17:37
Copy link
Contributor

Copilot AI left a 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.

Comment on lines +11 to +13
from rich.panel import Panel
from rich.table import Table
from rich import box
Copy link

Copilot AI Nov 10, 2025

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.

Suggested change
from rich.panel import Panel
from rich.table import Table
from rich import box

Copilot uses AI. Check for mistakes.
Comment on lines +26 to +27
pdd --force sync BASENAME

Copy link

Copilot AI Nov 10, 2025

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.

Suggested change
pdd --force sync BASENAME

Copilot uses AI. Check for mistakes.
@gltanaka
Copy link
Contributor

locally passes unit tests

haven't run regression/sync-regression target 11/10

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

--help text for pdd commands - output rich documentation

2 participants