CLI: Fixed cmds help strings#3566
Merged
Merged
Conversation
This fixes a few command help string outputs that were cut short because of a typo.
skshetry
approved these changes
Apr 1, 2020
shcheklein
approved these changes
Apr 1, 2020
Contributor
|
Thank you @xnutsive 🙏 |
jorgeorpinel
reviewed
Apr 6, 2020
Comment on lines
123
to
125
| "Show changes between commits in the DVC repository," | ||
| " or between a commit and the workspace." | ||
| " or between a commit and the workspace. " | ||
| "Prints the list of paths added, modified, or deleted." |
Contributor
There was a problem hiding this comment.
Show added, modified, or deleted data
between commits in the DVC repository,
or between a commit and the workspace
to match https://dvc.org/doc/command-reference/diff
I'll edit this in a separate PR... ⏳
Contributor
There was a problem hiding this comment.
(Including zsh autocomplete script.)
jorgeorpinel
reviewed
Apr 6, 2020
| " and system/environment information." | ||
|
|
||
| VERSION_HELP = ( | ||
| "Display the DVC version and system/environment information." |
Contributor
There was a problem hiding this comment.
I'll update docs to match this.
jorgeorpinel
added a commit
to treeverse/dvc.org
that referenced
this pull request
Apr 6, 2020
jorgeorpinel
added a commit
that referenced
this pull request
Apr 6, 2020
jorgeorpinel
added a commit
to treeverse/dvc.org
that referenced
this pull request
Apr 6, 2020
This was referenced Apr 6, 2020
efiop
pushed a commit
that referenced
this pull request
Apr 7, 2020
* diff: update help output to match docs per #3566 (review) * terms: git->Git, scm->SCM, spacing
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
This fixes a few command help string outputs that were cut short because of a typo:
This resulted in the CLI rendering only the first substring in the help section of the root
dvccommand.Since this is a small change that doesn't even change the CLI help messages, but rather fixes the existing ones, I haven't created an issue upfront.
I've walked through all the commands one by one, fixed the help strings where I noticed the bug.
❗ I have followed the Contributing to DVC checklist.
📖 If this PR requires documentation updates, I have created a separate PR (or issue, at least) in dvc.org and linked it here. If the CLI API is changed, I have updated tab completion scripts.
❌ I will check DeepSource, CodeClimate, and other sanity checks below. (We consider them recommendatory and don't expect everything to be addressed. Please fix things that actually improve code or fix bugs.)
Thank you for the contribution - we'll try to review it as soon as possible. 🙏