Skip to content
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

Add missing documentation - Faker::Address to Faker::Myst #1252

Merged
merged 10 commits into from
May 26, 2018

Conversation

vbrazo
Copy link
Member

@vbrazo vbrazo commented May 26, 2018

I'm reviewing the documentation vs APIs to see if we're missing docs.

Docs that are missing documentation:

This PR is related to this issue #1251.

@rafaelcpalmeida
Copy link
Contributor

Since you're working with Docs maybe you could clean this MD
https://github.com/stympy/faker/blob/master/doc/nation.md
It has a duplicate line

@vbrazo
Copy link
Member Author

vbrazo commented May 26, 2018

@rafaelcpalmeida definitely 👍

@vbrazo vbrazo force-pushed the fixes/add-missing-documentation branch from 0eaac3b to 20b7350 Compare May 26, 2018 18:53
@mrstebo
Copy link
Contributor

mrstebo commented May 26, 2018

@vbrazo I can work backwards and we can meet in the middle?

@vbrazo
Copy link
Member Author

vbrazo commented May 26, 2018

@mrstebo what do you mean?

@mrstebo
Copy link
Contributor

mrstebo commented May 26, 2018

@vbrazo I'll start from the top of the list of modules. So I'll start looking at Faker::Zelda and see if there are methods missing from the documentation.
Sound good?

@vbrazo
Copy link
Member Author

vbrazo commented May 26, 2018

Awesome. Start in Faker::Zelda and finish in Faker::Name. You should check if the API is declared in the README.md and also check in the docs if all the methods are documented correctly. If you believe we should add more docs, please add to your list. When you finish the verification, you could circle back and let us know how it looks. You could also open a new PR to work on the fixes if you prefer @mrstebo

It'd be nice if you could open the console irb and check if the methods work successfully as well. This would be a super awesome contribution.

@faker-ruby faker-ruby deleted a comment from mrstebo May 26, 2018
@vbrazo vbrazo changed the title Add missing documentation Add missing documentation - Faker::Address to Faker::Name May 26, 2018
@vbrazo vbrazo changed the title Add missing documentation - Faker::Address to Faker::Name Add missing documentation - Faker::Address to Faker::Myst May 26, 2018
@vbrazo vbrazo merged commit 70ce31c into master May 26, 2018
@vbrazo vbrazo deleted the fixes/add-missing-documentation branch May 27, 2018 00:08
@@ -3,5 +3,5 @@
```ruby
Faker::Community.characters #=> "Jeff Winger"

Faker::Community.quote #=> I fear a political career could shine a negative light on my drug dealing."
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to deprecate this method, because the Faker::Community hasn't been released yet.

davidmorton0 pushed a commit to davidmorton0/faker that referenced this pull request Jul 12, 2021
…mentation

Add missing documentation - Faker::Address to Faker::Myst
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants