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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

cli: add short alias for --show-{csv,json,md} #6711

Merged
merged 1 commit into from Sep 30, 2021

Conversation

skshetry
Copy link
Member

@skshetry skshetry commented Sep 30, 2021

As --csv/--json/--md

Fixes #6488. My plan is to replace options from docs soon and remove these options in 3.0 (though we could keep it, they won't cause any issues).

Documentation can be done after we merge this PR, as this is just an alias.

Thank you for the contribution - we'll try to review it as soon as possible. 馃檹

@skshetry skshetry added enhancement Enhances DVC ui user interface / interaction A: cli Related to the CLI labels Sep 30, 2021
@skshetry skshetry added this to In progress in DVC 22 Sep - 05 Oct 2021 via automation Sep 30, 2021
@skshetry skshetry self-assigned this Sep 30, 2021
@skshetry skshetry requested a review from a team as a code owner September 30, 2021 06:29
@@ -200,9 +201,11 @@ def add_parser(subparsers, parent_parser):
default=False,
)
diff_parser.add_argument(
"--md",
Copy link
Member Author

Choose a reason for hiding this comment

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

I always try to use -md (single dash) on these abbreviations, so I am not a fan of this, but --markdown is too long. And --md is what we use in CML as well.

Copy link
Contributor

@dberenbaum dberenbaum left a comment

Choose a reason for hiding this comment

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

Looks great! Are you planning a corresponding docs PR?

@skshetry
Copy link
Member Author

Looks great! Are you planning a corresponding docs PR?

yes, I'll submit one tomorrow.

@skshetry skshetry merged commit 9a1d740 into iterative:master Sep 30, 2021
DVC 22 Sep - 05 Oct 2021 automation moved this from In progress to Done Sep 30, 2021
@skshetry skshetry deleted the compat-flags branch September 30, 2021 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: cli Related to the CLI enhancement Enhances DVC ui user interface / interaction
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

metrics/params/exp: should the --show-* flags have a show prefix at all?
2 participants