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

Use term "settings" in dvc cache -h #1999

Closed
wants to merge 12 commits into from
Closed

Use term "settings" in dvc cache -h #1999

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
874013e
Document dvc.scm.git::Git::_get_diff_trees and shorten commit hashes …
jorgeorpinel Apr 19, 2019
3d2dc83
diff: Changes to dvc.scm.git so `dvc diff` outputs short SHAs
jorgeorpinel Apr 25, 2019
72ef858
Merge remote-tracking branch 'upstream/master'
jorgeorpinel May 3, 2019
4240ba3
Merge branch 'master' of github.com:iterative/dvc
jorgeorpinel May 8, 2019
98f461d
Undoes "Renames self.git for self.repo throughout module" introduced …
jorgeorpinel May 8, 2019
9516e70
diff: `dvc diff` uses code for `git rev_parse --short` instead of har…
jorgeorpinel May 9, 2019
872e42b
Merge branch 'master' of github.com:iterative/dvc
jorgeorpinel May 9, 2019
d5daa97
tests: Reformatted with `black tests/func/test_diff.py`
jorgeorpinel May 9, 2019
6e04c3c
tests: Remove uneccessary `str()` casting form `dvc diff` tests (and …
jorgeorpinel May 10, 2019
1cd0b4e
Merge remote-tracking branch 'upstream/master'
jorgeorpinel May 12, 2019
2e24a29
Merge branch 'master' of github.com:iterative/dvc
jorgeorpinel May 13, 2019
004185e
config: Updates usage output with better terminology
jorgeorpinel May 13, 2019
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
6 changes: 3 additions & 3 deletions dvc/command/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ def run(self):


def add_parser(subparsers, parent_parser):
CONFIG_HELP = "Get or set config options."
CONFIG_HELP = "Get or set config settings."
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

config_parser = subparsers.add_parser(
"config",
Expand All @@ -114,8 +114,8 @@ def add_parser(subparsers, parent_parser):
action="store_true",
help="Unset option.",
)
config_parser.add_argument("name", help="Option name.")
config_parser.add_argument("name", help="Setting name.")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, config is about config options, not settings. For example, take a look at git config --help.

Copy link
Contributor Author

@jorgeorpinel jorgeorpinel May 14, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I see that outputs usage: git config [<options>]
OK well, this PR was just a suggestion, we can close it and I'll go back to figure out another way to clarify the double use of the term "options" in https://dvc.org/doc/commands-reference/config

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, k. I see it now. How is Git doing it their docs - they should have the same problem - command line options + config options

Copy link
Contributor Author

@jorgeorpinel jorgeorpinel May 14, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Git also "overloads" the term "options" all over the git-config command description, but calls Git options <file-option> in the SYNOPSYS section. So that's an option.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to close this PR but please lmk if we want to call them "file-options" too. I'm probably going to fo with "DVC config options" or just "config options" for now.

config_parser.add_argument(
"value", nargs="?", default=None, help="Option value."
"value", nargs="?", default=None, help="Setting value."
)
config_parser.set_defaults(func=CmdConfig)