On 8/27/24 11:06, Tobias Burnus wrote:
Hi FX,
FX Coudert wrote:
Give it’s a doc patch, I think it might fall under the obvious rule,
and will commit in a week if there is no objection.
The patch clearly fixes a bug in the current specification and is fine,
I just wonder …
* libquadmath.texi (M_LOG2Eq, M_LOG10Eq, M_2_PIq): Fix
description of these constants.
diff --git a/libquadmath/libquadmath.texi b/libquadmath/libquadmath.texi
index dc2a9ff374b..ce4accf6421 100644
--- a/libquadmath/libquadmath.texi
+++ b/libquadmath/libquadmath.texi
…
@item @code{M_PI_2q}: pi divided by two
@item @code{M_PI_4q}: pi divided by four
@item @code{M_1_PIq}: one over pi
-@item @code{M_2_PIq}: one over two pi
+@item @code{M_2_PIq}: two over pi
@item @code{M_2_SQRTPIq}: two over square root of pi
@item @code{M_SQRT2q}: square root of 2
@item @code{M_SQRT1_2q}: one over square root of 2
... whether we should change the "over" which somehow sounds odd. "two
divided by pi" sounds better to me than "two over pi".
I do note, however, that the following documentation uses a slightly
different wording:
"M_2_PI -Two times the reciprocal of pi."
https://www.gnu.org/software/libc/manual/html_node/Mathematical-Constants.html
Hence, while I am fine with the change, I think we should replace the
"over" wording (multiple times) and move either to "divided by" or
[(…times) the reciprocal of".
I agree. I don't have a preference for which is better, but being
consistent with other documentation might be a winning argument.
Alas, Texinfo has lousy support for formatting mathematical equations,
so that's not an option.
-Sandra
