fix: descriptions #156
Merged
fix: descriptions #156
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kai687
commented
Apr 25, 2024
Contributor
|
Looks good, thanks @kai687! |
Contributor
Author
|
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? |
Contributor
|
@kai687 That sounds good 👍 |
Contributor
Author
|
Thanks! Can't merge myself. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 ?