Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review examples and help strings #477

Merged
merged 8 commits into from
Dec 5, 2024
Merged

Review examples and help strings #477

merged 8 commits into from
Dec 5, 2024

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Dec 5, 2024

Problem

  • Several commands are missing examples
  • The REPL command help strings are inconsistent with our other strings.
  • Some help strings are no longer aligned with our prospective docs.
  • Some database examples use my-database, which isn't valid (hyphens aren't allowed).

Solution

  • Adds command examples.
  • Reviews all command and REPL help strings.

@jrodewig jrodewig requested a review from a team as a code owner December 5, 2024 14:20
jrodewig and others added 7 commits December 5, 2024 10:06
@jrodewig jrodewig merged commit 05dec44 into v3 Dec 5, 2024
4 checks passed
@jrodewig jrodewig deleted the more-help-strings branch December 5, 2024 17:05
default: "default",
group: "login Options:",
group: "Login options:",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
group: "Login options:",

This arg shouldn't have a group (so it gets grouped with --help and --version).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha. This was just a capitalization change, but I'll remove it in a separate PR. Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR: #480

This was referenced Dec 6, 2024
@cleve-fauna cleve-fauna mentioned this pull request Dec 13, 2024
@wildemat wildemat mentioned this pull request Dec 18, 2024
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.

None yet

4 participants