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.

Sign up for GitHub

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

term: avoid "under X control" and other help output updates #3322

Merged
merged 14 commits into from
Feb 17, 2020
Merged

term: avoid "under X control" and other help output updates #3322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
b4e990d
get/import: update cmd and url arg descs with correct behavior
jorgeorpinel Feb 3, 2020
294633a
get/import: update path arg desc as well (See previous commit)
jorgeorpinel Feb 3, 2020
41e4b31
Merge branch 'master' of github.com:iterative/dvc
jorgeorpinel Feb 7, 2020
5001634
get/imp: udpate help output with simpler terms
jorgeorpinel Feb 7, 2020
d6e0903
api: url->URL in a docstring
jorgeorpinel Feb 10, 2020
e8cae07
metrics show: update help output per
jorgeorpinel Feb 10, 2020
328bf30
Merge pull request #1 from jorgeorpinel/2020-02-09
jorgeorpinel Feb 11, 2020
d80f1cf
Merge branch 'master' of github.com:iterative/dvc
jorgeorpinel Feb 11, 2020
58e2715
diff: update `diff` and `metrics diff` help desc to match docs
jorgeorpinel Feb 11, 2020
84e33e4
diff: update autocomplete scripts
jorgeorpinel Feb 12, 2020
3eded6d
diff: update help output again
jorgeorpinel Feb 13, 2020
d0ce5c4
diff/metrics diff: update help output yet again
jorgeorpinel Feb 13, 2020
90bb5f8
Merge branch 'master' of github.com:iterative/dvc
jorgeorpinel Feb 14, 2020
ceb1858
term" under X control -> tracked by X
jorgeorpinel Feb 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dvc/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@


class UrlNotDvcRepoError(DvcException):
"""Thrown if given url is not a DVC repository.
"""Thrown if given URL is not a DVC repository.

Args:
url (str): URL to the repository
Expand Down
6 changes: 4 additions & 2 deletions dvc/command/data_sync.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,8 @@ def add_parser(subparsers, _parent_parser):
pull_parser.set_defaults(func=CmdDataPull)

# Push
PUSH_HELP = "Push data files to a DVC remote storage."
PUSH_HELP = "Uploads files or directories tracked by DVC"
" to remote storage."

push_parser = subparsers.add_parser(
"push",
Expand Down Expand Up @@ -191,7 +192,8 @@ def add_parser(subparsers, _parent_parser):
push_parser.set_defaults(func=CmdDataPush)

# Fetch
FETCH_HELP = "Fetch data files from a DVC remote storage."
FETCH_HELP = "Get files or directories tracked by DVC from remote storage"
" into the cache."

fetch_parser = subparsers.add_parser(
"fetch",
Expand Down
5 changes: 3 additions & 2 deletions dvc/command/diff.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,9 @@ def run(self):

def add_parser(subparsers, parent_parser):
DIFF_DESCRIPTION = (
"Compare two versions of the DVC repository.\n"
"Shows the list of paths added, modified, or deleted"
"Show changes between commits in the DVC repository,"
" or between a commit and the workspace."
"Prints the list of paths added, modified, or deleted."
)
diff_parser = subparsers.add_parser(
"diff",
Expand Down
4 changes: 2 additions & 2 deletions dvc/command/metrics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,8 +273,8 @@ def add_parser(subparsers, parent_parser):
metrics_remove_parser.add_argument("path", help="Path to a metric file.")
metrics_remove_parser.set_defaults(func=CmdMetricsRemove)

METRICS_DIFF_HELP = "Show a table of changes between metrics among "
"versions of the DVC repository."
METRICS_DIFF_HELP = "Show changes in metrics between commits"
" in the DVC repository, or between a commit and the workspace."
metrics_diff_parser = metrics_subparsers.add_parser(
"diff",
parents=[parent_parser],
Expand Down
10 changes: 5 additions & 5 deletions scripts/completion/dvc.zsh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@

_dvc_commands() {
local _commands=(
"add:Take data files or directories under DVC control."
"add:Track data files or directories with DVC."
"cache:Manage cache settings."
"checkout:Checkout data files from cache."
"commit:Save changed data to cache and update DVC-files."
"config:Get or set config settings."
"destroy:Remove DVC-files, local DVC config and data cache."
"diff:Show a diff of a DVC controlled data file or a directory."
"fetch:Fetch data files from a DVC remote storage."
"diff:Show changes between commits in the DVC repository, or between a commit and the workspace."
"fetch:Get files or directories tracked by DVC from remote storage into the cache."
"get-url:Download or copy files from URL."
"get:Download data from DVC repository."
"gc:Garbage collect unused objects from cache or remote storage."
Expand Down Expand Up @@ -100,8 +100,8 @@ _dvc_destroy=(
_dvc_diff=(
"--show-json[Format the output into a JSON]"
"--checksums[Display checksums for each entry]"
"1:Git reference to the older version:"
"2:Git reference to the newer version:"
"1:Old Git commit to compare (defaults to HEAD):"
"2:New Git commit to compare (defaults to the current workspace):"
)

_dvc_fetch=(
Expand Down