Handle array examples; document Example usage #1807
Merged
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
leon-barrett
force-pushed
the
leon/example-doc
branch
from
08f5251
to
3bc9e60
Compare
casualjim
approved these changes
Nov 29, 2018
casualjim
reviewed
Nov 29, 2018
docs/use/spec/model.md
Outdated
| @@ -74,6 +75,7 @@ type User struct { | |||
| // the email address for this user | |||
| // | |||
| // required: true | |||
| // example: user@provider.net | |||
There was a problem hiding this comment.
How come this alignment is off ?
There was a problem hiding this comment.
sorry, accidentally made spaces instead of a tab. (Elsewhere in the file spaces are used, so it confused my editor.) Fixed.
leon-barrett
force-pushed
the
leon/example-doc
branch
from
3bc9e60
to
3370a15
Compare
added 3 commits
November 30, 2018 11:19
I previously added JSON parsing for examples on object types; this adds it for array types. It also adds basic documentation for Example. Signed-off-by: Leon Barrett <leon@cogitai.com>
Signed-off-by: Leon Barrett <leon@cogitai.com>
leon-barrett
force-pushed
the
leon/example-doc
branch
from
3370a15
to
c95492a
Compare
casualjim
approved these changes
Nov 30, 2018
|
@casualjim Thanks. Is there anything else I need to do? (I can't merge. Do I need to figure out commit signing first?) |
|
Yes all commits must be pgp signed |
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.
I previously added JSON parsing for examples on object types; this adds
it for array types. It also adds basic documentation for Example.