Fix #404: Refactor root and improve its style. #408
Conversation
|
Hi @shcheklein, kindly review! Thanks! |
|
|
||
| ```usage | ||
| usage: dvc root [-h] [-q] [-v] | ||
| ``` | ||
|
|
||
| ## Description | ||
|
|
||
| While modifying code in different sub-directories, there can be cases when |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Ok, I'll ask on Discord. Thanks!
There was a problem hiding this comment.
Great stuff @vibhor98 ! 🎉
- double check the motivation, ask on Discord.
- check the examples - they should be easily runnable
|
Hi @shcheklein, I've improved the motivation after referring the original feature request #779. Also, I installed dvc on my Mac and checked the examples. They are easily runnable. Please review! |
| While in project's sub-directory, sometimes developers may want to refer some | ||
| file belonging to another directory. This command returns relative path to the | ||
| DVC project's root directory from the current working directory. So, this | ||
| command can be used to build a path to a dependency file, command, or output. |
There was a problem hiding this comment.
So, am I correct that this command was not built to be used inside DVC-files? (cc @efiop). The primary use case is to simplify developers' life when they run dvc run. And make dvc run executable effectively from any subdirectory. So, primarily it can be useful if I use a script that generates some stage files?
There was a problem hiding this comment.
@shcheklein Correct. But it can also be used in dvc files as well, just by using it in the command itself, so that it is evaluated each time the command is ran.
|
Hi @shcheklein, shall I take up other issue while waiting for @efiop reply? Thanks! |
|
Guys, sorry for the delay. |
|
@jorgeorpinel I’ll work on closing this out. |
Fixes #404 to refactor
rootcommand reference guide and improve its style to be aligned with other commands.