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

dvc: check all command usage and options vs docs after main 1.0 release #4024

Closed
jorgeorpinel opened this issue Jun 11, 2020 · 2 comments
Closed
Assignees
Labels
awaiting response we are waiting for your reply, please respond! :) enhancement Enhances DVC ui user interface / interaction

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Jun 11, 2020

After the top items (mission critical) in iterative/dvc.org/issues/1255 are done.

  1. Check that docs reflect latest usage strings and options from core.
  2. Open a PR here with any output string update written to the command references in docs.

Full sync!

@jorgeorpinel jorgeorpinel transferred this issue from iterative/dvc.org Jun 11, 2020
@triage-new-issues triage-new-issues bot added the triage Needs to be triaged label Jun 11, 2020
@jorgeorpinel jorgeorpinel added enhancement Enhances DVC ui user interface / interaction labels Jun 11, 2020
@triage-new-issues triage-new-issues bot removed the triage Needs to be triaged label Jun 11, 2020
@jorgeorpinel jorgeorpinel changed the title cmd ref: check all command usage and options vs core after main 1.0 release dvc: check all command usage and options vs docs after main 1.0 release Jun 11, 2020
@efiop
Copy link
Contributor

efiop commented Jun 11, 2020

@jorgeorpinel shouldn't this be in the docs themselves? This is unrealistic to check it twice: once when writing docs that are created out-of-sync with the core repo and then going through the core repo again searching for desyncs. Let's create the tickets as we go.

@efiop efiop added the awaiting response we are waiting for your reply, please respond! :) label Jun 11, 2020
@jorgeorpinel
Copy link
Contributor Author

Yes you're right we need to do it in docs first. But when doing that some times the usage strings are improved so that's what I mean here. A full sync both ways.

Updated description and added checkbox in iterative/dvc.org/issues/1255.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting response we are waiting for your reply, please respond! :) enhancement Enhances DVC ui user interface / interaction
Projects
None yet
Development

No branches or pull requests

2 participants