From 4a8bf80bf8745e16258cc7d997616be5a1e4cdda Mon Sep 17 00:00:00 2001 From: Roland Walker Date: Sat, 3 Oct 2026 15:36:46 -0400 Subject: [PATCH] align one-line app descriptions with README.md incidentally preferring long options in Click helpdoc examples --- AGENTS.md | 2 +- changelog.md | 5 +++++ mycli/main.py | 4 ++-- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 94092a85..5d475458 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,6 +1,6 @@ # Mycli -A command line client for MySQL with auto-completion and syntax highlighting. +Rich MySQL terminal client with auto-completion, syntax highlighting, and dataframes. ## Project Structure diff --git a/changelog.md b/changelog.md index 3a279b65..3236984a 100644 --- a/changelog.md +++ b/changelog.md @@ -1,6 +1,11 @@ Upcoming (TBD) ============== +Documentation +-------- +* Align all uses of one-line app description with `README.md`. + + Internal -------- * Add Python 3.15 trove classifier. diff --git a/mycli/main.py b/mycli/main.py index f081147e..f5776aa7 100755 --- a/mycli/main.py +++ b/mycli/main.py @@ -471,12 +471,12 @@ def preprocess_cli_args( def click_entrypoint( cli_args: CliArgs, ) -> None: - """A MySQL terminal client with auto-completion and syntax highlighting. + """Rich MySQL terminal client with auto-completion, syntax highlighting, and dataframes. \b Examples: - mycli my_database - - mycli -u my_user -h my_host.com my_database + - mycli --user my_user --host my_host.com my_database - mycli mysql://my_user@my_host.com:3306/my_database """