cmd ref: describe update available output (for import stages) in status #477#1299
Conversation
There was a problem hiding this comment.
Great start!
In addition to improving the description you added (see the one commend in this review, below), can you also please update one of the examples or add a new one that shows this "update available" case?
The best strategy for both things, so you're 100% sure you understand and thus explain what's happening, is to actually create a couple DVC repos (A and B) locally, dvc add some dummy data in A, use dvc import to bring it to B, update the data in A, and run dvc status in B. This way you will see exactly how DVC behaves under this situation and you'll be able to copy-paste the command output for the examples.
Please ping me on discord if you need more details on setting that up.
We do this kind of micro QA all the time when writing docs, which also helps you become a DVC expert little by little 🙂
|
@jorgeorpinel thank you for your review. I have updated the explanation with more details. Also made an attempt to include an example. |
|
@imhardikj thanks 🙏 |
jorgeorpinel
left a comment
There was a problem hiding this comment.
Yep, this is great. I just have some minor comments and suggestions for you. We can merge this after addressing those. Thanks @imhardikj!
|
Thanks again @imhardikj |
This PR updates
\static\docs\commands-reference\status.mdwithupdate availableoutput for import stages to fix #477.