diff mbox

[v2,2/6] Describe remainder as primary and drem as alternative in the manual

Message ID 1498067125-30472-3-git-send-email-gftg@linux.vnet.ibm.com
State New
Headers show

Commit Message

Gabriel F. T. Gomes June 21, 2017, 5:45 p.m. UTC 
New since v1.

-- 8< --
In preparation for the documentation of _FloatN and _FloatNx variants of
the remainder function, this patch changes the descriptions of remainder
and drem, so that remainder is described as primary and drem as an
alternative name for the same functionality.

	* manual/arith.texi (Remainder Functions): Describe remainder as
	primary and drem as an alternative name.  Change the comment on
	remainder to ISO, since it is defined in ISO C99.
---
 manual/arith.texi | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

Comments

Joseph Myers June 21, 2017, 11:25 p.m. UTC | #1 
On Wed, 21 Jun 2017, Gabriel F. T. Gomes wrote:

> New since v1.
> 
> -- 8< --
> In preparation for the documentation of _FloatN and _FloatNx variants of
> the remainder function, this patch changes the descriptions of remainder
> and drem, so that remainder is described as primary and drem as an
> alternative name for the same functionality.
> 
> 	* manual/arith.texi (Remainder Functions): Describe remainder as
> 	primary and drem as an alternative name.  Change the comment on
> 	remainder to ISO, since it is defined in ISO C99.

OK.
diff mbox

Patch

diff --git a/manual/arith.texi b/manual/arith.texi
index dd6020c..e403cb5 100644
--- a/manual/arith.texi
+++ b/manual/arith.texi
@@ -1591,31 +1591,31 @@  less than the magnitude of the @var{denominator}.
 If @var{denominator} is zero, @code{fmod} signals a domain error.
 @end deftypefun
 
-@deftypefun double drem (double @var{numerator}, double @var{denominator})
-@deftypefunx float dremf (float @var{numerator}, float @var{denominator})
-@deftypefunx {long double} dreml (long double @var{numerator}, long double @var{denominator})
-@standards{BSD, math.h}
+@deftypefun double remainder (double @var{numerator}, double @var{denominator})
+@deftypefunx float remainderf (float @var{numerator}, float @var{denominator})
+@deftypefunx {long double} remainderl (long double @var{numerator}, long double @var{denominator})
+@standards{ISO, math.h}
 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
 These functions are like @code{fmod} except that they round the
 internal quotient @var{n} to the nearest integer instead of towards zero
-to an integer.  For example, @code{drem (6.5, 2.3)} returns @code{-0.4},
-which is @code{6.5} minus @code{6.9}.
+to an integer.  For example, @code{remainder (6.5, 2.3)} returns
+@code{-0.4}, which is @code{6.5} minus @code{6.9}.
 
 The absolute value of the result is less than or equal to half the
 absolute value of the @var{denominator}.  The difference between
-@code{fmod (@var{numerator}, @var{denominator})} and @code{drem
+@code{fmod (@var{numerator}, @var{denominator})} and @code{remainder
 (@var{numerator}, @var{denominator})} is always either
 @var{denominator}, minus @var{denominator}, or zero.
 
-If @var{denominator} is zero, @code{drem} signals a domain error.
+If @var{denominator} is zero, @code{remainder} signals a domain error.
 @end deftypefun
 
-@deftypefun double remainder (double @var{numerator}, double @var{denominator})
-@deftypefunx float remainderf (float @var{numerator}, float @var{denominator})
-@deftypefunx {long double} remainderl (long double @var{numerator}, long double @var{denominator})
+@deftypefun double drem (double @var{numerator}, double @var{denominator})
+@deftypefunx float dremf (float @var{numerator}, float @var{denominator})
+@deftypefunx {long double} dreml (long double @var{numerator}, long double @var{denominator})
 @standards{BSD, math.h}
 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
-This function is another name for @code{drem}.
+This function is another name for @code{remainder}.
 @end deftypefun
 
 @node FP Bit Twiddling