-
Notifications
You must be signed in to change notification settings - Fork 26
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
fix: descriptions #156
fix: descriptions #156
Conversation
Looks good, thanks @kai687! |
Good question! The links depend on the pages in the docs being there. I thought it would be too much of a dependency. Like, the flags themselves are coming from the specs and the links depend on the old docs. If we ever want to change that, we need to update the CLI as well. For now, I could add back links to pages that exist. WDYT? |
@kai687 That sounds good 👍 |
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.
LGTM ✅
Thanks! Can't merge myself. |
Extract the first sentence of the parameter description and uses it as help text.
I wrote the specs such that the first sentence is followed by an empty line, followed by more information. For the CLI, we can extract the first sentence and use it as help text.
I replace any Markdown links
[link text](https://some/url)
withlink text
,so that it reads nicely in the terminal.
What do you think @clemfromspace ?