-
Notifications
You must be signed in to change notification settings - Fork 99
Better documentation for base provider functionality #10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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
pimjansen
approved these changes
Nov 16, 2020
06433b0
to
30ecd36
Compare
@bramceulemans let me know once done so i can clone this to review |
Will do, it might take a while. I'm currently on the I will add a checklist to the PR so you can see the progress. |
dd5fcb4
to
4eebfc6
Compare
247065c
to
f06f754
Compare
db31aed
to
7335b34
Compare
7523d8f
to
f293f4d
Compare
@pimjansen initial version is done. |
pimjansen
approved these changes
Nov 19, 2020
Awesome work @bramceulemans ! |
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.
In order to make scanning easier for the eyes, it was decided that each function / formatter should have it's own section. A formatters section should contain the function name, a description and examples (in a code block).
Documented providers:
Faker\Provider\Base
Faker\Provider\Lorem
Faker\Provider\DateTime
Faker\Provider\Internet
Faker\Provider\UserAgent
Faker\Provider\Payment
Faker\Provider\Color
Faker\Provider\File
Faker\Provider\Image
Faker\Provider\Uuid
Faker\Provider\Barcode
Faker\Provider\Miscellaneous
Faker\Provider\Biased
Faker\Provider\HtmlLorem
This issue closes #6