diff options
| author | Paul Eggert | 2015-09-16 16:23:55 -0700 |
|---|---|---|
| committer | Paul Eggert | 2015-09-16 16:26:07 -0700 |
| commit | 032ce1c7d1afb23e6b1265d91c5a97e45de071ce (patch) | |
| tree | dab9ca1e540c23aeb15ee9ef8fdc6b78e1929b6d /src/floatfns.c | |
| parent | 309d39b832ccd72f99cc726090ff03f7e146948d (diff) | |
| download | emacs-032ce1c7d1afb23e6b1265d91c5a97e45de071ce.tar.gz emacs-032ce1c7d1afb23e6b1265d91c5a97e45de071ce.zip | |
Omit unnecessary \ before paren in C docstrings
Although \( is needed in docstrings in Elisp code, it is not needed in
docstrings in C code, since C function definitiions do not start with
a parenthesis. The backslashes made the docstrings a bit harder to
read and to format in columns. Also, some C docstrings had ( in
column 1 and this did not appear to be causing any problems. So,
simplify C docstrings by replacing \( with ( and \) with ).
Diffstat (limited to 'src/floatfns.c')
| -rw-r--r-- | src/floatfns.c | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/floatfns.c b/src/floatfns.c index 63d35b8ad6b..46eb85ff8ca 100644 --- a/src/floatfns.c +++ b/src/floatfns.c | |||
| @@ -170,7 +170,7 @@ Cause an error if X1 or X2 is not a float. */) | |||
| 170 | DEFUN ("frexp", Ffrexp, Sfrexp, 1, 1, 0, | 170 | DEFUN ("frexp", Ffrexp, Sfrexp, 1, 1, 0, |
| 171 | doc: /* Get significand and exponent of a floating point number. | 171 | doc: /* Get significand and exponent of a floating point number. |
| 172 | Breaks the floating point number X into its binary significand SGNFCAND | 172 | Breaks the floating point number X into its binary significand SGNFCAND |
| 173 | \(a floating point value between 0.5 (included) and 1.0 (excluded)) | 173 | (a floating point value between 0.5 (included) and 1.0 (excluded)) |
| 174 | and an integral exponent EXP for 2, such that: | 174 | and an integral exponent EXP for 2, such that: |
| 175 | 175 | ||
| 176 | X = SGNFCAND * 2^EXP | 176 | X = SGNFCAND * 2^EXP |
| @@ -454,7 +454,7 @@ With optional DIVISOR, return the nearest integer to ARG/DIVISOR. | |||
| 454 | 454 | ||
| 455 | Rounding a value equidistant between two integers may choose the | 455 | Rounding a value equidistant between two integers may choose the |
| 456 | integer closer to zero, or it may prefer an even integer, depending on | 456 | integer closer to zero, or it may prefer an even integer, depending on |
| 457 | your machine. For example, \(round 2.5\) can return 3 on some | 457 | your machine. For example, (round 2.5) can return 3 on some |
| 458 | systems, but 2 on others. */) | 458 | systems, but 2 on others. */) |
| 459 | (Lisp_Object arg, Lisp_Object divisor) | 459 | (Lisp_Object arg, Lisp_Object divisor) |
| 460 | { | 460 | { |
| @@ -491,7 +491,7 @@ fmod_float (Lisp_Object x, Lisp_Object y) | |||
| 491 | 491 | ||
| 492 | DEFUN ("fceiling", Ffceiling, Sfceiling, 1, 1, 0, | 492 | DEFUN ("fceiling", Ffceiling, Sfceiling, 1, 1, 0, |
| 493 | doc: /* Return the smallest integer no less than ARG, as a float. | 493 | doc: /* Return the smallest integer no less than ARG, as a float. |
| 494 | \(Round toward +inf.\) */) | 494 | (Round toward +inf.) */) |
| 495 | (Lisp_Object arg) | 495 | (Lisp_Object arg) |
| 496 | { | 496 | { |
| 497 | double d = extract_float (arg); | 497 | double d = extract_float (arg); |
| @@ -501,7 +501,7 @@ DEFUN ("fceiling", Ffceiling, Sfceiling, 1, 1, 0, | |||
| 501 | 501 | ||
| 502 | DEFUN ("ffloor", Fffloor, Sffloor, 1, 1, 0, | 502 | DEFUN ("ffloor", Fffloor, Sffloor, 1, 1, 0, |
| 503 | doc: /* Return the largest integer no greater than ARG, as a float. | 503 | doc: /* Return the largest integer no greater than ARG, as a float. |
| 504 | \(Round towards -inf.\) */) | 504 | (Round towards -inf.) */) |
| 505 | (Lisp_Object arg) | 505 | (Lisp_Object arg) |
| 506 | { | 506 | { |
| 507 | double d = extract_float (arg); | 507 | double d = extract_float (arg); |