diff options
| author | Maciek Rząsa <maciejrzasa@gmail.com> | 2022-07-28 14:30:10 +0200 |
|---|---|---|
| committer | git <svn-admin@ruby-lang.org> | 2022-09-25 16:51:17 +0900 |
| commit | 8e2c42518355f3e29f5693de9034fb66a2abbdaf (patch) | |
| tree | e91c0d7cdc952a4ff4ffba2f2651d0095f1591e9 /ext/bigdecimal | |
| parent | 81b919ce5c85a82d68de9ccaebd5036adef8c7fb (diff) | |
[ruby/bigdecimal] Improve documentation of BigDecimal#sign
Fixes https://github.com/ruby/bigdecimal/issues/78 by describing behaviour for positive and negative zero in the docs.
https://github.com/ruby/bigdecimal/commit/5415b120ab
Diffstat (limited to 'ext/bigdecimal')
| -rw-r--r-- | ext/bigdecimal/bigdecimal.c | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/ext/bigdecimal/bigdecimal.c b/ext/bigdecimal/bigdecimal.c index b3ef70a2c9..06c8251cc2 100644 --- a/ext/bigdecimal/bigdecimal.c +++ b/ext/bigdecimal/bigdecimal.c @@ -3606,8 +3606,10 @@ BigDecimal_limit(int argc, VALUE *argv, VALUE self) /* Returns the sign of the value. * - * Returns a positive value if > 0, a negative value if < 0, and a - * zero if == 0. + * Returns a positive value if > 0, a negative value if < 0. + * It behaves the same with zeros - + * it returns a positive value for a positive zero (BigDecimal('0')) and + * a negative value for a negative zero (BigDecimal('-0')). * * The specific value returned indicates the type and sign of the BigDecimal, * as follows: |