Switch shorthand doc gen over to new approach. #1467
Merged
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.
This PR updates the shorthand documenter to work with the latest changes to the shorthand code (#1461). Specifically:
It also changes some small things in the way docs are generated:
--argnameis removed in the shorthand example. This is to make the shorthand syntax consistent with the JSON example syntax.values. Before we'd haveKey=value,Foo=value. Now we'll haveKey=string,Foo=float.And finally, there's a few areas of improvement I think we'll need to make in the future:
(... recursive ...), which is how JSON params are documented. This might be an area for improvement.cc @kyleknap @mtdowling @rayluo