Skip to content

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

Merged
skshetry merged 1 commit into
treeverse:masterfrom
skshetry:compat-flags
Sep 30, 2021
Merged

cli: add short alias for --show-{csv,json,md}#6711
skshetry merged 1 commit into
treeverse:masterfrom
skshetry:compat-flags

Conversation

@skshetry

@skshetry skshetry commented Sep 30, 2021

Copy link
Copy Markdown
Collaborator

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 requested a review from dberenbaum September 30, 2021 06:29
@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
Comment thread dvc/command/diff.py
default=False,
)
diff_parser.add_argument(
"--md",

Copy link
Copy Markdown
Collaborator 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.

@dberenbaum dberenbaum left a comment

Copy link
Copy Markdown
Contributor

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
Copy Markdown
Collaborator Author

Looks great! Are you planning a corresponding docs PR?

yes, I'll submit one tomorrow.

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

None yet

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