Skip to content

Correct documented workgroup option spelling - #90

Open
dajiaohuang wants to merge 1 commit into
dbcli:mainfrom
dajiaohuang:docs/work-group-option-20261016
Open

dajiaohuang wants to merge 1 commit into
dbcli:mainfrom
dajiaohuang:docs/work-group-option-20261016

Conversation

@dajiaohuang

Copy link
Copy Markdown

Description

The README help excerpt and AWS configuration precedence page advertise --work-group, but the CLI registers --work_group. Copying the documented spelling exits with code 2 (No such option '--work-group'. Did you mean '--work_group'?) before connecting.

Correct both references to match the existing CLI and docs/usage.rst; no CLI behavior change.

Validation: compared both corrected references with public CliRunner --help, verified the old spelling is rejected, and exercised the supported spelling through the public execute path with an owned PyAthena mock. Isolated HOME/config, synthetic credentials, SDK automatic credential discovery disabled and network blocked; no AWS requests. git diff --check passes. No full documentation build was run.

Checklist

  • I've added this contribution to the changelog.md.
  • I've added my name to the AUTHORS file (or it's already there).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant