Skip to content

docs: add usage examples to --help output (closes #374)#486

Open
cemheren wants to merge 1 commit into
mainfrom
grow/help-examples-2
Open

docs: add usage examples to --help output (closes #374)#486
cemheren wants to merge 1 commit into
mainfrom
grow/help-examples-2

Conversation

@cemheren

Copy link
Copy Markdown
Owner

What

Appends an Examples block to PrintHelp() so --help shows common workflows at a glance, matching the convention of git --help / curl --help.

Examples shown

Examples:
  ExcelConsole data.csv                              Launch desktop wallpaper with a CSV
  ExcelConsole data.csv --export-md out.md           Convert CSV to a Markdown table
  ExcelConsole data.csv --export-html out.html       Convert CSV to a styled HTML table
  ExcelConsole data.csv --export-json -              Print CSV as JSON to stdout
  ExcelConsole --list-extensions                     List installed extensions

Notes

  • Uses only flags that actually exist today (the issue's sample referenced --info and -d, which aren't implemented yet — omitted to keep help truthful).
  • Pure string output in one method, no logic changes.
  • dotnet build clean (0 warnings, 0 errors); verified output via --help.

Closes #374

Append an Examples block to PrintHelp() showing common workflows
using only existing flags (export-md/html/json, list-extensions).

Closes #374
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.

Add usage examples to --help output

1 participant