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

cmd: status examples #1952

Merged
merged 15 commits into from
Dec 4, 2020
Merged

cmd: status examples #1952

merged 15 commits into from
Dec 4, 2020

Conversation

imhardikj
Copy link
Contributor

@imhardikj imhardikj commented Nov 18, 2020

Partially Addresses #1824:

  • status examples in all docs (including consistent indentation

@shcheklein shcheklein temporarily deployed to dvc-landing-statuscmd-dajo2pra November 18, 2020 07:13 Inactive
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.

A few deets ^

@jorgeorpinel jorgeorpinel changed the title Statuscmd cmd: status examples Nov 23, 2020
@jorgeorpinel
Copy link
Contributor

Is this still a draft PR though?

@jorgeorpinel jorgeorpinel mentioned this pull request Nov 23, 2020
12 tasks
@imhardikj imhardikj marked this pull request as ready for review November 23, 2020 14:00
@imhardikj
Copy link
Contributor Author

@jorgeorpinel One example of fetch that requires indentation correction is having a merge conflict so I'll open a separate PR for that.

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.

One example of fetch that requires indentation correction is having a merge conflict

I don't see the merge conflict anymore and I see this is a regular PR so I'm approving.

BUT there's one or two minor details left, mentioned above, so not merging yet. Pleas ping me when ready @imhardikj. Thanks

Comment on lines 160 to 167
dofoo:
changed deps:
modified: bar
changed outs:
not in cache: foo
dobar:
changed outs:
deleted: bar
Copy link
Contributor

Choose a reason for hiding this comment

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

But now we need to worry about the consistency of the example. How come dofoo comes first but it uses bar as a dependency? bar is the output of dobar which comes after...

Please try to actually codify these examples in a dvc.yaml file and run repro/status as needed so they make sense.

Copy link
Contributor Author

@imhardikj imhardikj Nov 28, 2020

Choose a reason for hiding this comment

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

changing deps of dofoo to baz make it is consistent. It will become a simple pipeline:

+---------+  
| baz.dvc |  
+---------+  
      *      
      *      
      *      
 +-------+   
 | dofoo |   
 +-------+   
      *      
      *      
      *      
 +-------+   
 | dobar |   
 +-------+ 

Considering that foo is a dependency of dobar.

Copy link
Contributor

Choose a reason for hiding this comment

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

Better! But the current example doesn't show a connection between dofoo and dobar. In fact dobar is a separate pipeline altogether as it has no dependencies.

Copy link
Contributor

Choose a reason for hiding this comment

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

Have you actually codified it in dvc.yaml so we can see what the output would be? I'm not sure about how status orders stages, maybe it's chronological, maybe it's alphabetical?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes I actually made this pipeline. The output of status was correct as it was after executing dofoo stage with --no-commit. In the new update it shows connection between stages.

Copy link
Contributor Author

@imhardikj imhardikj Dec 4, 2020

Choose a reason for hiding this comment

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

So it prints baz.dvc at the end

Most of times baz.dvc was in starting. If you check in commit f0ff0ee, I moved baz.dvc to starting. Here in this review #1952 (comment), output of status was correct was actually meant for baz.dvc at starting.
But in the next commit b54bf7b I moved it back to last because I was testing this and got this output once, so I thought this was also correct. But yes majority of times baz.dvc was in starting only that's why I changed it in f0ff0ee.

Copy link
Contributor

Choose a reason for hiding this comment

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

It should be in the beginning. I'm glad I double checked this... I'll fix it later.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can I open the PR for this. There's one more example remaining in fetch which requires indentation change. I removed it from this PR as it was showing merge conflict. #1952 (comment)

Copy link
Contributor

Choose a reason for hiding this comment

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

I have the change stashed locally already, so it will get to the repo eventually. But feel free to send a PR, sure. No big deal either way.

Copy link
Contributor

Choose a reason for hiding this comment

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

p.s. don't shy away from merge conflicts 🙂

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.

Need to check consistency of the exmples, actually.

@iterative iterative deleted a comment from imhardikj Dec 4, 2020
@jorgeorpinel
Copy link
Contributor

Done 🙂

@jorgeorpinel jorgeorpinel merged commit 9890369 into master Dec 4, 2020
@jorgeorpinel jorgeorpinel deleted the statuscmd branch December 21, 2020 23:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants