On Thu, 18 Jul 2024 13:40:38 GMT, Raffaello Giulietti <rgiulie...@openjdk.org> wrote:
>> fabioromano1 has updated the pull request incrementally with one additional >> commit since the last revision: >> >> More accurate comment > > src/java.base/share/classes/java/math/MutableBigInteger.java line 2135: > >> 2133: * @param limit the offset which is the end of valid words in the >> input value >> 2134: * @param blockLen the length of the block in units of 32 bits >> 2135: */ > > At first, I couldn't understand that `blockIndex` goes in the opposite > direction as the array indices. Also, "starting" is very confusing, because > no `int` at `blockIndex*blockLen` gets copied AFAIU. > > Two improvements: > * Add a `@return` tag. Alternatively, use comments other than JavaDoc `/**`. > * Make it explicit that the direction of `blockIndex` is the opposite of the > array indices, and reconsider the wording like "starting", etc. For the sake of information: the documentation of this method is actually based on that of `MBI.getBlock(int, int, int)`, which has the same problems. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/19710#discussion_r1682999848