Repository navigation
docs: add missing options to the README help output - #1660
Aryapatel-007 wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01ABeCNynHoGeGAKW21tKwAB
Why is that? And if you have merely guessed what the output looks like, then aren't you putting the burden of checking on the maintainers' shoulders? I mean, we maintainers would probably have checked, but here we're not just checking: we're doing the work. So why submit a pull request? Just submit an issue, then. Please do not submit pull requests if you do not or cannot use pgcli. |
|
You're right, and I'm sorry. I used an AI tool for this PR, and it couldn't run pgcli when it prepared it, so that check got left to you. That shouldn't have happened. |
Description
The
pgcli --helpoutput in the README is missing options thatpgcli/main.pydefines:--timeout,--application-name,-t/--tuples-only,--ping,--ssh-tunnel,--log-file,--init-command,-c/--command,-y/--yesand-f/--file. It also shows--warn [all|moderate|off], but the option now has noChoicetype, so it's--warn TEXT.Please check the formatting: I couldn't run
pgcli --helpin my environment. I built this block from the@click.optiondefinitions, in their order, following Click's layout, so the spacing or wrapping may differ slightly from the real output. Replacing it with real output would be fine.AI disclosure: this PR was generated by Claude Code (Claude Opus 5.5).
Update: when I opened this PR I hadn't run
pgcli --help, as the note above says, and that check shouldn't have been left to you. I've since installed this branch and run it, and the README block matches the real output exactly at 80 columns.tests/test_main.pygave 93 passed and 23 skipped (those need a local Postgres server), andREADME.rstparses with docutils. I haven't tested against a live database.Checklist
changelog.rst.AUTHORSfile (or it's already there).pip install pre-commit && pre-commit install).