Added examples folder && update README.md #3
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
|
Oh I am so sorry I missed this!!! Not sure why github didnt send me an email about it. I like the readme updates. For the examples instead of a subfolder I like to create ExampleFunctionName and do outputs for the values. That way when docs are generated you can have your actual examples show in usages and they will be treated as tests as well. I run Gofakeit as well and here is an link of how I do examples for it. https://github.com/brianvoe/gofakeit/blob/master/auth_test.go#L60 If you want to update it to use examples like this ill get this pr merged in ASAP! Thanks again. |
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 created _examples folder to contain all example files. Also updated README.md with an install, and updated all examples.