cmd-ref: document checkout displaying changes

[skshetry]

You may disregard these recommendations if you used the Edit on GitHub button from dvc.org to improve a doc in place.

❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.

🐛 Please make sure to mention Fix #issue (if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.

Please chose to allow us to edit your branch when creating the PR.

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

iterative/dvc#3401 is under review. I have kept this docs to minimum, as the PR is more in relation with UI than any behavioral change. But. I see that, the behavior that it would checkout silent if there's an error was mentioned, which I have adjusted a bit. Also, some places look good to show outputs of dvc checkout.

[skshetry]

I tried adding outputs of dvc checkout, but my internet has really taken a hit lately. And, I don't think, it matters much at the moment. So, I have rollbacked this to only document reference.

[shcheklein]

@skshetry could we at least remove existing wrong outputs (if any)? Or all of them silent now?

[jorgeorpinel]

2 small things but I also think we should def. review all the instances of dvc checkout usage in sample console blocks and remove any outdated output or, if relevant, update it with the current version's output.

We could take this over if needed.

[shcheklein]

@skshetry @jorgeorpinel what is the status of this, guys?

[jorgeorpinel]

@shcheklein idk but I just committed my suggestions since this has been waiting for a long time now. Should we take it over? Or we can merge it and open a separate issue for

could we at least remove existing wrong outputs (if any)? Or all of them silent now?

Stale

[skshetry]

@jorgeorpinel, @shcheklein, sorry, this got lost in my notifications. AFAICT the docs do not have any outputs on checkouts (and, as checkouts were silent before), so, we don't need to change other parts.

[shcheklein]

@jorgeorpinel yes, let's take this over and update checkout outputs. I would not do this everywhere - only in places where checkout is the topic of a section/paragraph.

[jorgeorpinel]

could we at least remove existing wrong outputs (if any)? Or all of them silent now?

There's already no output samples for dvc checkout in code blocks... We can merge this!

[jorgeorpinel]

I did merge master since this branch is kind of old, and updated the main example in the checkout cmd ref (including the actual command output).

[shcheklein]

looks good overall, see a few comments

I took over this PR.

[jorgeorpinel]

at least data versioning use case and tutorial should benefit from adding dvc checkout outputs

Done in a819927 (for all use cases)

Also solved merge conflicts now.

[shcheklein]

just one minor typo