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 help text and examples #538

Merged
merged 5 commits into from
Dec 17, 2024
Merged

Review help text and examples #538

merged 5 commits into from
Dec 17, 2024

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Dec 17, 2024

Problem

The help text is currently inconsistent and, in some areas, erroneous or incomplete. It's also a bit wordy in places.

Solution

Addresses issues in the help text:

  • Indicate fauna database create/delete can be used for top-level DBs.
  • Change --performanceHints to kebab-case.
  • Use space-separated lists for array value examples.
  • Use --no- for false boolean values.
  • Replace Mutually exclusive with with Can't be used with
  • Add /dir to /path/to/schema/ examples
  • Remove unneeded formatting.
  • Add examples for fauna local
  • Where possible, reword the text for brevity.

Result

Better docs? ✨

Testing

npm run test:local. Also manually reviewed all -h output.

@jrodewig jrodewig requested a review from a team as a code owner December 17, 2024 17:20
Copy link
Contributor

@ecooper ecooper left a comment

Choose a reason for hiding this comment

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

Nice.

That performanceHints miss must have been during a merge. I swear I changed it earlier. 😆

@jrodewig jrodewig merged commit 00b81f1 into v3 Dec 17, 2024
4 checks passed
@jrodewig jrodewig deleted the help-review branch December 17, 2024 18:08
@mwilde345 mwilde345 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.

3 participants