Help fixes #23
Help fixes #23
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR modifies how help aliases are formatted by removing option placeholders and increasing the column width; it also updates a fallback usage hint in the TUI parser and simplifies the create-volume usage hint.
- Strips optional flag placeholders from several command aliases and expands alias padding from 30 to 40 characters.
- Changes the fallback error usage hint to reference a general
/helpcommand. - Reduces the create-volume
usage_hintto only include the required--nameparameter.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| chuck_data/ui/help_formatter.py | Removed detailed option placeholders from certain commands and increased padding. |
| chuck_data/service.py | Updated fallback usage message to use a generic /help reference. |
| chuck_data/commands/create_volume.py | Simplified the usage_hint by omitting optional flags. |
Comments suppressed due to low confidence (1)
chuck_data/commands/create_volume.py:108
- The updated
usage_hintomits the optional flags (--catalog_name,--schema_name,--volume_type), which could confuse users who need those options; consider restoring them to the hint.
usage_hint="Usage: /create-volume --name <volume_name>",
| alias = f"{alias} <query>" | ||
| elif cmd_name == "scan-schema-for-pii" or cmd.name == "scan-schema-for-pii": | ||
| alias = f"{alias} [--catalog_name <catalog>] [--schema_name <schema>]" | ||
| alias = f"{alias}" |
There was a problem hiding this comment.
These assignments simply reassign the same value to alias and are effectively no-ops; consider removing these redundant branches or combining them with the default case.
|
|
||
| # Format the command with its description | ||
| return f"{alias:<30} - {cmd.description}" | ||
| return f"{alias:<40} - {cmd.description}" |
There was a problem hiding this comment.
The hard-coded padding width 40 is a magic number; extracting it into a named constant (e.g., ALIAS_COLUMN_WIDTH) would improve readability and ease future adjustments.
| return f"{alias:<40} - {cmd.description}" | |
| return f"{alias:<{ALIAS_COLUMN_WIDTH}} - {cmd.description}" |
No description provided.