Skip to content

Refine several items in the helpdoc - #2348

Merged
rolandwalker merged 1 commit into
mainfrom
RW/refine-helpdoc-items
Oct 10, 2026
Merged

rolandwalker merged 1 commit into
mainfrom
RW/refine-helpdoc-items

Conversation

@rolandwalker

Copy link
Copy Markdown
Contributor

Description

  • refer to the "server" rather than the "database" in contexts such as the host and port
  • among many, only --port had the Honors <variable> text; remove it
  • a UDS has a path but is not a true file
  • shorten some entries
  • spell out "certificate"
  • change wording so that zsh descriptive completions make more sense, preferring to lead with "Whether to"
  • make metavars more consistent, and more consistent with text
  • ~/.myclirc is usually written with the tilde

Checklist

  • I added this contribution to the changelog.md file.
  • I added my name to the mycli/AUTHORS.txt file (or it's already there).
  • To lint and format the code, I ran
    uv run ruff check && uv run ruff format && uv run mypy --install-types .

 * refer to the "server" rather than the "database" in contexts such as
   the host and port
 * among many, only --port had the "Honors <variable>" text; remove it
 * a UDS has a path but is not a true file
 * shorten some entries
 * spell out "certificate"
 * change wording so that zsh descriptive completions make more sense,
   preferring to lead with "Whether to"
 * make metavars more consistent, and more consistent with text
 * ~/.myclirc is usually written with the tilde
@rolandwalker rolandwalker self-assigned this Oct 10, 2026
@rolandwalker
rolandwalker merged commit 8e25e86 into main Oct 10, 2026
12 checks passed
@rolandwalker
rolandwalker deleted the RW/refine-helpdoc-items branch October 10, 2026 12:56
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.

1 participant