X Tutup
The Wayback Machine - https://web.archive.org/web/20201218092130/https://github.com/faker-ruby/faker/pull/1753
Skip to content

/ faker

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

Jump to bottom

Add YARD docs for Date, Time, and Number #1753

Merged
merged 6 commits into from Sep 22, 2019
Merged

Add YARD docs for Date, Time, and Number #1753

merged 6 commits into from Sep 22, 2019

Conversation

@connorshea
Copy link
Contributor

@connorshea connorshea commented Sep 19, 2019

Pretty much what it says on the tin, not a huge one this time :)

I also moved around some rubocop enable/disable comments to avoid their inclusion in docs.
connorshea added 4 commits Sep 19, 2019
@connorshea
Add YARD docs for Faker::Time.
Verified
This commit was signed with a verified signature.
connorshea Connor Shea
GPG key ID: 7FF97FB48289A157 Learn about signing commits
efc976f
@connorshea
Add YARD docs for Faker::Date.
Verified
This commit was signed with a verified signature.
connorshea Connor Shea
GPG key ID: 7FF97FB48289A157 Learn about signing commits
d96fd63
@connorshea
Oops, forgot return types for Date and Time.
Verified
This commit was signed with a verified signature.
connorshea Connor Shea
GPG key ID: 7FF97FB48289A157 Learn about signing commits
cdbf06f
@connorshea
Add YARD docs for Faker::Number.
Verified
This commit was signed with a verified signature.
connorshea Connor Shea
GPG key ID: 7FF97FB48289A157 Learn about signing commits
Loading status checks…
5a2314c
@connorshea
Copy link
Contributor Author

@connorshea connorshea commented Sep 19, 2019 

lib/faker/default/time.rb:37:97: C: Style/AsciiComments: Use only ascii symbols in comments.

      #   Faker::Time.between(from: DateTime.now - 1, to: DateTime.now, format: :long) #=> "2018年10月16日(火) 10時48分27秒 -0500"

hmmm
@Zeragamba
Zeragamba requested changes Sep 19, 2019
View changes
lib/faker/default/date.rb Outdated Show resolved Hide resolved
lib/faker/default/date.rb Outdated Show resolved Hide resolved
lib/faker/default/number.rb Show resolved Hide resolved
lib/faker/default/time.rb Outdated Show resolved Hide resolved
@connorshea
Update some YARD docs to resolve feedback.
Verified
This commit was signed with a verified signature.
connorshea Connor Shea
GPG key ID: 7FF97FB48289A157 Learn about signing commits
Loading status checks…
711843b 
Fix some phrasing, add missing version tags, fix a Rubocop warning by
disabling the cop, and clarify the possible values for period in
Faker::Time.
@connorshea connorshea requested a review from Zeragamba Sep 19, 2019
@Zeragamba
Zeragamba requested changes Sep 20, 2019
View changes
Copy link
Contributor

@Zeragamba Zeragamba left a comment

Other then updating the Date examples, looks good to me now.
lib/faker/default/date.rb Outdated Show resolved Hide resolved
@Zeragamba
Copy link
Contributor

@Zeragamba Zeragamba commented Sep 20, 2019

Dang it Github, that was supposed to be a new comment there...

Date.rb:15

As mentioned in another PR, thesegenerators return Date objects instead of Strings, so our examples should reflect that.
@connorshea
Update returned date object in examples.
Verified
This commit was signed with a verified signature.
connorshea Connor Shea
GPG key ID: 7FF97FB48289A157 Learn about signing commits
Loading status checks…
44efce8
@connorshea
Copy link
Contributor Author

@connorshea connorshea commented Sep 20, 2019

@Zeragamba updated :)
@Zeragamba
Zeragamba approved these changes Sep 20, 2019
View changes
Copy link
Contributor

@Zeragamba Zeragamba left a comment

All good to me here now.
@connorshea connorshea mentioned this pull request Sep 21, 2019
Closed
181 of 181 tasks complete
@vbrazo
vbrazo approved these changes Sep 22, 2019
View changes
Copy link
Member

@vbrazo vbrazo left a comment

👍
@vbrazo vbrazo merged commit cf2c268 into faker-ruby:master Sep 22, 2019
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@connorshea connorshea deleted the connorshea:add-even-more-yard-docs branch Feb 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vbrazo vbrazo

@Zeragamba Zeragamba

Assignees

@connorshea connorshea

Labels
Documentation
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
@connorshea @Zeragamba @vbrazo
You can’t perform that action at this time.
X Tutup