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.

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

wants to merge 12 commits into from

Conversation

jorgeorpinel
Copy link
Contributor

@jorgeorpinel jorgeorpinel commented May 14, 2019

  • 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.


@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented May 14, 2019

dvc/command/config.py Show resolved Hide resolved
@@ -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

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants