RFR: 8266578: Disambiguate BigDecimal description of scale
Ignasi Marimon-Clos
github.com+762126+ignasi35 at openjdk.java.net
Thu May 6 11:57:13 UTC 2021
The API Docs for `BigDecimal` introduce the meaning of `scale`. The current writeup can be missleading when presenting the meaning of a `scale` value that's negative. Hopefully, with this PR, the sentence is more clear.
The ambiguity is on this sentence:
> If negative, the unscaled value of the number is ...
Instead, I suggest the more verbose:
> If the scale is negative, the unscaled value of the number is ...
To keep symmetry, I've also reviewed the positive case from:
> If zero or positive, the scale is the number of digits ...
to:
> If the scale is zero or positive, the scale is the number of digits ...
-------------
Commit messages:
- Merge branch 'master' into minor-disambiguation
- Disambiguate the BigDecimal docs
Changes: https://git.openjdk.java.net/jdk/pull/582/files
Webrev: https://webrevs.openjdk.java.net/?repo=jdk&pr=582&range=00
Issue: https://bugs.openjdk.java.net/browse/JDK-8266578
Stats: 6 lines in 1 file changed: 1 ins; 0 del; 5 mod
Patch: https://git.openjdk.java.net/jdk/pull/582.diff
Fetch: git fetch https://git.openjdk.java.net/jdk pull/582/head:pull/582
PR: https://git.openjdk.java.net/jdk/pull/582
More information about the core-libs-dev
mailing list