]> Cypherpunks repositories - gostls13.git/commit
math: improve documentation of Copysign
authorJoe Tsai <joetsai@digital-static.net>
Wed, 13 Apr 2022 20:31:24 +0000 (13:31 -0700)
committerGopher Robot <gobot@golang.org>
Thu, 14 Apr 2022 17:42:53 +0000 (17:42 +0000)
commit62b8ec744b8e10b80f9271fed93116387c9128ef
treeada410ebc3dd74b271ffb5521fb7b27faab7c261
parentcb702a2a5670d4fa599f573b37b1a01abc9f995a
math: improve documentation of Copysign

Name the arguments in a way that is more self-describing.
Many code editor tools show a snippet of the function and
its arguments. However, "x" and "y" are not helpful in determining
which is the sign and which is the magnitude,
short of reading the documentation itself.

Name the sign argument as "sign" to be explicit.
This follows the same naming convention as IsInf.

Change-Id: Ie3055009e475f96c92d5ea7bfe9828eed908c78b
Reviewed-on: https://go-review.googlesource.com/c/go/+/400177
Run-TryBot: Joseph Tsai <joetsai@digital-static.net>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Ian Lance Taylor <iant@google.com>
Auto-Submit: Ian Lance Taylor <iant@google.com>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
src/math/copysign.go