-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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.
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
Conversation
…in dvc.scm.git::Git::get_diff_trees
- Docstring for Git class constructor - Renames self.git for self.repo throughout module (involves several test changes) - Better doc and logical refactor in Git._get_diff_trees - `dvc diff` now outputs short SHA strings (Git._get_diff_trees) - hard coded to 7 length str (involves some test changes in tests/func/test_diff.py) For #1902
…d `[:7]` (for short commit hashes). - Tests updated too. Per #1906 (comment)
Matches this docs change: https://github.com/iterative/dvc.org/pull/331/files#diff-efa51f4bb4922f00bd8afd1ad364ca9dR10 |
@@ -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.") |
There was a problem hiding this comment.
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
.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Have you followed the guidelines in our
Contributing document?
Does your PR affect documented changes or does it add new functionality
that should be documented? If yes, have you created a PR for
dvc.org documenting it or at
least opened an issue for it? If so, please add a link to it.