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.

Sign up for GitHub

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

Fix #404: Refactor root and improve its style. #408

Merged
merged 2 commits into from
Jun 11, 2019
Merged

Fix #404: Refactor root and improve its style. #408

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
141715b
Refactor root doc.
vibhor98 Jun 5, 2019
1a35d75
Improvise motivation behind root.
vibhor98 Jun 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion static/docs/commands-reference/root.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,18 @@

Returns relative path to project's directory.

Can be used to build a path to a dependency, command, or output.
## Synopsis

```usage
usage: dvc root [-h] [-q] [-v]
```

## Description

While modifying code in different sub-directories, there can be cases when
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure I understand this to be honest, could you elaborate please? Even better can you ask a question on our Discord chat to get more information and insights?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, I'll ask on Discord. Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done, PTAL!

developers require relative path to the DVC's root directory. So, this command
can be used to build a path to a dependency, command, or output.

## Options

- `-h`, `--help` - prints the usage/help message, and exit.
Expand Down