Skip to content

guide: update types of checksums in dvc.lock doc#1527

Merged
jorgeorpinel merged 4 commits into
masterfrom
guide/dvclock/GS-md5
Jul 8, 2020
Merged

guide: update types of checksums in dvc.lock doc#1527
jorgeorpinel merged 4 commits into
masterfrom
guide/dvclock/GS-md5

Conversation

@jorgeorpinel
Copy link
Copy Markdown
Contributor

per #1494 (review)

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 choose 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. 🙏

@shcheklein shcheklein temporarily deployed to dvc-landing-guide-dvclo-a2uywm July 4, 2020 18:27 Inactive
@jorgeorpinel

This comment has been minimized.

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-guide-dvclo-a2uywm July 4, 2020 19:36 Inactive
@jorgeorpinel jorgeorpinel force-pushed the guide/dvclock/GS-md5 branch from 0de9b53 to 294e76c Compare July 4, 2020 19:44
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-guide-dvclo-a2uywm July 4, 2020 19:44 Inactive
Comment thread content/docs/user-guide/dvc-files-and-directories.md Outdated
Copy link
Copy Markdown
Contributor

@shcheklein shcheklein left a comment

Choose a reason for hiding this comment

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

good stuff, a minor comment

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-guide-dvclo-a2uywm July 8, 2020 21:47 Inactive
@jorgeorpinel jorgeorpinel merged commit b251aff into master Jul 8, 2020
Copy link
Copy Markdown
Contributor Author

@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.

Merged but I have more questions about .dvc file fields...

Cc @skshetry @efiop 🙂

Comment thread content/docs/user-guide/dvc-files-and-directories.md
- `outs` (always present): List of <abbr>output</abbr> entries (details below)
that represent the files or directories tracked with DVC. Typically there is
only one (but several can be added or combined manually).
- `deps`: List of <abbr>external dependency</abbr> entries (details below). Only
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

deps in .dvc files are always external, right?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@jorgeorpinel No, import-url works with in-repo files too. Not much product sense in that, but still.

Comment on lines +58 to +60
- `wdir` (optional): Working directory for the `outs` and `deps` paths (relative
to the `.dvc` file's location). If this field is not present explicitly, it
defaults to `.` (the `.dvc` file's location).
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Do .dvc files even have wdir now? I think Ruslan said it's never generated byt DVC commands but you can put it in manually (thus I called it "optional").

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes, they do.

Copy link
Copy Markdown
Contributor

@efiop efiop Jul 8, 2020

Choose a reason for hiding this comment

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

Not only by-hand, but with dvc add --file too.

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