ui: '-j' option now mentions docs #4382
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
pared
approved these changes
Aug 14, 2020
efiop
reviewed
Aug 14, 2020
dvc/command/data_sync.py
Outdated
Comment on lines
100
to
101
| help="Number of jobs to run simultaneously. " | ||
| "Refer to docs to get default value.", |
There was a problem hiding this comment.
Maybe let's just copypaste from docs? E.g. from https://dvc.org/doc/command-reference/push
The default value is 4 * cpu_count(). For SSH remotes, the default is 4. Using more jobs may improve the overall transfer speed.
There was a problem hiding this comment.
I've noticed that most help messages are short (2 sentences max) so I decided to use "refer to docs...". However, I have no strong opinion in that regard. If it's fine to have long messages I can copy text from cmd ref.
There was a problem hiding this comment.
Yes, there is no limit for the help messages. We could totally copypaste those two sentences :) Thank you! 🙏
There was a problem hiding this comment.
I've updated message
efiop
approved these changes
Aug 15, 2020
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.
Fixes #1310
❗ 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.
I don't think that documentation should be updated.