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

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
Member

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
Copy link
Member Author 

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 reviewed 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.
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.
Zeragamba
Zeragamba requested changes Sep 20, 2019
View reviewed changes
Copy link
Contributor

@Zeragamba Zeragamba left a comment

Choose a reason for hiding this comment

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

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

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
Copy link
Member Author

@Zeragamba updated :)

Zeragamba
Zeragamba approved these changes Sep 20, 2019
View reviewed changes
Copy link
Contributor

@Zeragamba Zeragamba left a comment

Choose a reason for hiding this comment

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

All good to me here now.

@connorshea connorshea mentioned this pull request Sep 21, 2019
Closed
vbrazo
vbrazo approved these changes Sep 22, 2019
View reviewed changes
Copy link
Member

@vbrazo vbrazo left a comment

Choose a reason for hiding this comment

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

👍

@vbrazo vbrazo merged commit cf2c268 into faker-ruby:master Sep 22, 2019
@connorshea connorshea deleted the add-even-more-yard-docs branch February 15, 2020 23:17
davidmorton0 pushed a commit to davidmorton0/faker that referenced this pull request Jul 12, 2021
@vbrazo
Merge pull request faker-ruby#1753 from connorshea/add-even-more-yard…
b24b21f 
…-docs

Add YARD docs for Date, Time, and Number
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vbrazo vbrazo vbrazo approved these changes

@Zeragamba Zeragamba Zeragamba approved these changes

Assignees

@connorshea connorshea

Labels
📘 Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@connorshea @Zeragamba @vbrazo