Add documentation into code and examples #27
Merged
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
This moves the API part of the example usage document into the code where the API is present. Signed-off-by: David Brown <dmlb2000@gmail.com>
This adds better docs to the bookstore example and adds it to the exampleusage page. Signed-off-by: David Brown <dmlb2000@gmail.com>
dmlb2000
force-pushed
the
fix-22-document-examples
branch
from
e7041c5 to
cc2b369
Compare
dmlb2000
changed the title
markborkum
approved these changes
Jun 11, 2019
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.
Description
This moves the API part of the example usage document into the
code where the API is present. This also adds examples from the test
suite into the documentation tree.
Signed-off-by: David Brown dmlb2000@gmail.com
Issues Resolved
Fix #22
Check List