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 strings #451

Merged
merged 7 commits into from
Dec 4, 2024
Merged

Review help strings #451

merged 7 commits into from
Dec 4, 2024

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Dec 3, 2024

Ticket(s): DOCS-3864

Problem

Some of the various help strings and examples could use more detail and formatting.

Solution

Adds detail and formatting to help strings and examples.

Testing

Linted + reviewed using ./src/user-entrypoint.mjs <command>.

@jrodewig jrodewig requested a review from a team as a code owner December 3, 2024 19:34
@jrodewig jrodewig requested a review from a team December 3, 2024 21:11
src/cli.mjs Outdated Show resolved Hide resolved
src/cli.mjs Outdated Show resolved Hide resolved
src/cli.mjs Outdated Show resolved Hide resolved
src/cli.mjs Outdated Show resolved Hide resolved
src/commands/database/create.mjs Show resolved Hide resolved
src/commands/schema/commit.mjs Show resolved Hide resolved
src/commands/schema/commit.mjs Show resolved Hide resolved
src/lib/command-helpers.mjs Outdated Show resolved Hide resolved
@jrodewig
Copy link
Contributor Author

jrodewig commented Dec 4, 2024

Merging. I'll take another pass once we get closer to release.

@jrodewig jrodewig merged commit 8bbdb35 into v3 Dec 4, 2024
4 checks passed
@jrodewig jrodewig deleted the improve-help-strings branch December 4, 2024 18:35
@cleve-fauna cleve-fauna mentioned this pull request Dec 5, 2024
This was referenced Dec 6, 2024
@cleve-fauna cleve-fauna mentioned this pull request Dec 13, 2024
@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