docs: Improve CLI command documentation #1505
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
orpheuslummis
added
action/no-benchmark
Codecov ReportPatch coverage:
@@ Coverage Diff @@
## develop #1505 +/- ##
===========================================
+ Coverage 74.94% 74.95% +0.01%
===========================================
Files 203 203
Lines 21084 21091 +7
===========================================
+ Hits 15800 15807 +7
- Misses 4206 4207 +1
+ Partials 1078 1077 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 6 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
|
question: I noticed short descriptions ending without a period and long descriptions ending with a period, is there a reason for this inconsistency in punctuation? |
|
Stylistic choice |
fredcarle
approved these changes
Jun 5, 2023
fredcarle
force-pushed
the
orpheus/docs/cli-documentation
branch
from
016d562
to
d9c875f
Compare
shahzadlone
approved these changes
Jul 14, 2023
fredcarle
force-pushed
the
orpheus/docs/cli-documentation
branch
2 times, most recently
from
df1b173
to
666c62c
Compare
shahzadlone
reviewed
Jul 19, 2023
fredcarle
force-pushed
the
orpheus/docs/cli-documentation
branch
from
2af9ff5
to
a26ff0d
Compare
shahzadlone
reviewed
Jul 20, 2023
shahzadlone
pushed a commit
to shahzadlone/defradb
that referenced
this pull request
Feb 23, 2024
## Relevant issue(s) Resolves sourcenetwork#1229 ## Description Updates some documentation of the of CLI commands Co-authored-by: Fred Carle <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relevant issue(s)
Resolves #1229
Description
Updates some documentation of the of CLI commands
Feedback welcome on the terminology used in the CLI documentation strings
How has this been tested?
Manual