-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Add links to documentation for all commands #1767
Conversation
I have added documentation links to all the commands that I could find through |
This is great, @J0 ! Thanks. I suggest I add a dvc shortener for these links - something like |
@J0 man.dvc.org is alive. Try this: https://man.dvc.org/metrics or https://man.dvc.org/metrics-show |
@J0 take a look at |
@J0 also, let's add help messages for subcommands as well - for example - https://man.dvc.org/metrics-show for |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great stuff!
See my comments to fix small things.
It might be better to squash 32 commits into 1-10. Otherwise it might break our beautiful contributors-graph by creating a spike and changing the graph scale :)
|
Hey @shcheklein sounds good to me -- I'll get to it in about 10 minutes :) |
@J0 no rush, thanks! I think we need to keep https:// prefix. There are some terminals that can make them clickable automatically. I'm not sure about man.dvc.org without the prefix. I would double check that. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! 🎉 A minor formatting issue down below.
dvc/command/add.py
Outdated
@@ -26,7 +26,8 @@ def run(self): | |||
|
|||
|
|||
def add_parser(subparsers, parent_parser): | |||
ADD_HELP = "Add files/directories to dvc." | |||
ADD_HELP = "Add files/directories to dvc. \n\ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's reformat all of these this way:
ADD_HELP = (
"Add files/directories to dvc. \n"
"documentation: https://man.dvc.org/add"
)
so it is unified everywhere and we don't mix \ into all of these.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok done
Signed-off-by: Ruslan Kuprieiev <ruslan@iterative.ai>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! 🎉
Fix #1729 . It seems that there isn't any documentation for
dvc daemon
anddvc pkg
so I am omitting it for now.