Minor updates to schema export/import command documentation #2681
Conversation
This file contains 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
* include CLI header section * stop using entity chars in synopsis markdown sections
…rray causes the synopsis to not be printed at all.
zachmu
approved these changes
Jan 28, 2022
| @@ -43,7 +43,7 @@ Running dolt init in an already initialized directory will fail. | |||
| `, | |||
|
|
|||
| Synopsis: []string{ | |||
| //`[{{.LessThan}}options{{.GreaterThan}}] [{{.LessThan}}path{{.GreaterThan}}]`, | |||
| "", | |||
There was a problem hiding this comment.
Making it an empty slice will cause help and markdown to omit the synopsis section. Probably okay for this simple command, but it's nice for consistency in the docs for all commands to have the same sections.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.