Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add YARD docs to Faker::Twitter #1983

Merged
merged 2 commits into from
May 17, 2020
Merged

Add YARD docs to Faker::Twitter #1983

merged 2 commits into from
May 17, 2020

Conversation

danielTiringer
Copy link
Contributor

Issue#

#1762

Description:

Add complete YARD docs for Faker::Twitter methods.

@danielTiringer
Copy link
Contributor Author

I made the return type a [Hash]. Please advise if a list of hash keys / value types are preferred, i.e. in this format found in a yard issue:

@return [Hash]

* :key [String] a key that accepts a string object

* :otherkey [Date] the date object to pass in

...

Personally I would keep it as it is

@Zeragamba Zeragamba merged commit e48abea into faker-ruby:master May 17, 2020
@danielTiringer danielTiringer deleted the add-twitter-docs branch May 17, 2020 14:27
@connorshea connorshea mentioned this pull request May 21, 2020
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants