-
Notifications
You must be signed in to change notification settings - Fork 394
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
Conversation
Co-authored-by: Restyled.io <[email protected]>
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.
@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.
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 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
That's up to the core team cc @efiop what's the planned version for this, perhaps a minor release increment? |
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.
@skshetry could you remind us about this when the feature is released? Thanks
@jorgeorpinel, ping. 2.8.0 was released yesterday. |
@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 👼 |
we should used anonymised analytics to be more objective :) |
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.
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]>
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.