Skip to content

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
merged 13 commits into from
Nov 19, 2020

Conversation

bram-pkg
Copy link
Member

@bram-pkg bram-pkg commented Nov 16, 2020

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

@pimjansen
Copy link
Contributor

@bramceulemans let me know once done so i can clone this to review

@bram-pkg
Copy link
Member Author

bram-pkg commented Nov 16, 2020

Will do, it might take a while. I'm currently on the Faker\Provider\DateTime.

I will add a checklist to the PR so you can see the progress.

@bram-pkg bram-pkg marked this pull request as ready for review November 18, 2020 17:14
@bram-pkg bram-pkg requested a review from pimjansen November 18, 2020 17:14
@bram-pkg
Copy link
Member Author

@pimjansen initial version is done.

@pimjansen pimjansen merged commit d72d96e into main Nov 19, 2020
@pimjansen pimjansen deleted the base-provider-docs branch November 19, 2020 07:33
@pimjansen
Copy link
Contributor

Awesome work @bramceulemans !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Separate built-in providers to their own page
2 participants