-
Notifications
You must be signed in to change notification settings - Fork 67
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
Enhanced RDoc for selected methods #204
Conversation
@mrkn, I don't want to put up anything more until you've had a chance to comment on this PR. That will give me good guidance going forward. |
* | ||
* Examples: | ||
* | ||
* BigDecimal('111111.111').add(1, 0) # => 0.111112111e6 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@BurdetteLamar Could you please add the line to specify the rounding mode explicitly before this line?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@BurdetteLamar Could you please use :half_up
instead of BigDecimal::ROUND_HALF_UP
because I want to promote using a symbol instead of a constant?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. But I have used :half_up
(the default) because that's how the examples were made.
By the way, I strongly agree that the symbol is better.
@mrkn, is this ready to merge? |
Thank you very much. |
Treated:
A couple of things I've made consistent with usage over at ruby/ruby:
add
, I've calledndigits
.Document-method
is not needed.I also discovered that
+
andadd
are different, and have documented them separately.