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

Document short aliases --csv/--json/--md flags #2877

Merged
merged 4 commits into from
Oct 20, 2021

Conversation

skshetry
Copy link
Member

@skshetry skshetry commented Oct 1, 2021

We replaced --show-csv/--show-json/--show-md with short aliases --csv/--json/--md respectively in iterative/dvc#6711. Though even if the --show-* are still supported, I am removing those mentions from the docs, as it may confuse users. I did not touch blogs when making the changes.

The change is not released yet, so we may want to wait for merging this.

@skshetry skshetry self-assigned this Oct 1, 2021
@shcheklein shcheklein temporarily deployed to dvc-org-short-alias-csv-fmoq2w October 1, 2021 02:39 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-short-alias-csv-fmoq2w October 1, 2021 02:40 Inactive
Copy link
Contributor

@daavoo daavoo left a comment

Choose a reason for hiding this comment

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

@iterative/docs this feels like the kind of change that should be associated with a release number somehow.

I can imagine people trying to run the command from previous versions and failing.

Copy link
Contributor

@casperdcl casperdcl left a comment

Choose a reason for hiding this comment

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

I suppose it's fine to leave --show-hash as-is.

Also older versions of DVC will fail with e.g. --json as @daavoo pointed out but I don't think it's a problem:

  • would require old version of DVC but reading new version of docs (affects few people)
  • it's easy to run --help to find out supported flags

@casperdcl casperdcl added content-dvc C: ref Content of /doc/*-reference labels Oct 1, 2021
@jorgeorpinel
Copy link
Contributor

this feels like the kind of change that should be associated with a release number somehow

That's up to the core team cc @efiop what's the planned version for this, perhaps a minor release increment?

Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

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

@skshetry could you remind us about this when the feature is released? Thanks

@skshetry
Copy link
Member Author

@jorgeorpinel, ping. 2.8.0 was released yesterday.

@casperdcl
Copy link
Contributor

casperdcl commented Oct 12, 2021

@jorgeorpinel maybe we could wait a few days before merging? to reduce chance of potential issues from users of old versions reading current docs? #2877 (review)

@daavoo
Copy link
Contributor

daavoo commented Oct 13, 2021

@jorgeorpinel maybe we could wait a few days before merging? to reduce chance of potential issues from users of old versions reading current docs? #2877 (review)

Sounds a little like a flaky heuristic 👼

@casperdcl
Copy link
Contributor

we should used anonymised analytics to be more objective :)

@iesahin iesahin added A: docs Area: user documentation (gatsby-theme-iterative) and removed dvc labels Oct 14, 2021
Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

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

Looks like a grep replace which is what we needed. Thanks @skshetry !

* Restyled by prettier

* Update show.md

* Update show.md

Co-authored-by: Restyled.io <[email protected]>
Co-authored-by: Ivan Shcheklein <[email protected]>
@shcheklein shcheklein merged commit 9c7def0 into master Oct 20, 2021
@shcheklein shcheklein deleted the short-alias-csv-json-md branch October 20, 2021 16:45
@daavoo daavoo mentioned this pull request Oct 20, 2021
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants