This is the mail archive of the fortran@gcc.gnu.org mailing list for the GNU Fortran project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[Patch, fortran] Typo and grammatical fixes in intrinsic.texi (repost)


:ADDPATCH fortran:

(Resending; I forgot the cc: to patches!)

In looking over Daniel Franke's recent intrinsic.texi patch, I noticed a
few typos and small errors that were in the original file.  Most of
these are pretty trivial (some cut-and-paste errors, some typos, a few
bits of tortured grammar); the one that perhaps merits most note is that
the MODULO() documentation erroneously included the table of specific
names from MOD().  Thus this patch, to fix those existing errors.

I do have a question for future corrections: in the examples of
procedure calls, where should spaces be inserted?  Should we have (for
instance) @code(C = FUN(X,Y[,Z[,KIND]])}, or @code{C = FUN(X, Y, [, Z [,
KIND]])}, or spaces only some of those places, or...?  Also, in the
"Syntax" entries, should we have discrete examples for each allowable
argument combination, or is []-notation allowable there?  In both of
these cases, the existing documentation is inconsistent.

Finally, I'll note that this is my first patch submission, so I hope I'm
doing it right; advice/corrections welcome!  I do have a copyright
assignment on file, but I don't have write access, so someone else will
have to commit this for me if it's approved.

Thanks,
- Brooks


2006-08-23 Brooks Moses <bmoses@stanford.edu>


* intrinsic.texi: Minor corrections and grammatical fixes.

Index: intrinsic.texi
===================================================================
--- intrinsic.texi	(revision 116361)
+++ intrinsic.texi	(working copy)
@@ -36,7 +36,7 @@
 * @code{ABORT}:         ABORT,     Abort the program     
 * @code{ABS}:           ABS,       Absolute value     
 * @code{ACHAR}:         ACHAR,     Character in @acronym{ASCII} collating sequence
-* @code{ACOS}:          ACOS,      Arc cosine function
+* @code{ACOS}:          ACOS,      Arccosine function
 * @code{ADJUSTL}:       ADJUSTL,   Left adjust a string
 * @code{ADJUSTR}:       ADJUSTR,   Right adjust a string
 * @code{AIMAG}:         AIMAG,     Imaginary part of complex number
@@ -311,7 +311,7 @@
 
 
 @node ACOS
-@section @code{ACOS} --- Arc cosine function 
+@section @code{ACOS} --- Arccosine function 
 @findex @code{ACOS} intrinsic
 @findex @code{DACOS} intrinsic
 @cindex arc cosine
@@ -495,7 +495,7 @@
 
 
 @node AINT
-@section @code{AINT} --- Imaginary part of complex number  
+@section @code{AINT} --- Truncate to a whole number  
 @findex @code{AINT} intrinsic
 @findex @code{DINT} intrinsic
 @cindex whole number
@@ -740,7 +740,7 @@
 argument if the optional @var{KIND} is absent; otherwise, the kind
 type parameter will be given by @var{KIND}.  If @var{X} is greater than
 zero, then @code{ANINT(X)} returns @code{AINT(X+0.5)}.  If @var{X} is
-less than or equal to zero, then return @code{AINT(X-0.5)}.
+less than or equal to zero, then it returns @code{AINT(X-0.5)}.
 
 @item @emph{Example}:
 @smallexample
@@ -857,7 +857,7 @@
 
 @item @emph{Return value}:
 The return value is of type @code{REAL(*)} and it lies in the
-range @math{-\pi / 2 \leq \arccos (x) \leq \pi / 2}.  The kind type
+range @math{-\pi / 2 \leq \arcsin (x) \leq \pi / 2}.  The kind type
 parameter is the same as @var{X}.
 
 @item @emph{Example}:
@@ -976,7 +976,7 @@
 
 @item @emph{Return value}:
 The return value is of type @code{REAL(*)} and it lies in the
-range @math{ - \pi / 2 \leq \arcsin (x) \leq \pi / 2}.
+range @math{ - \pi / 2 \leq \arctan (x) \leq \pi / 2}.
 
 @item @emph{Example}:
 @smallexample
@@ -1023,7 +1023,7 @@
 
 @item @emph{Return value}:
 The return value has the same type and kind type parameter as @var{Y}.
-It is the principle value of the complex number @math{X + i Y}.  If
+It is the principal value of the complex number @math{X + i Y}.  If
 @var{X} is nonzero, then it lies in the range @math{-\pi \le \arccos (x) \leq \pi}.
 The sign is positive if @var{Y} is positive.  If @var{Y} is zero, then
 the return value is zero if @var{X} is positive and @math{\pi} if @var{X}
@@ -1494,7 +1494,7 @@
 
 @table @asis
 @item @emph{Description}:
-@code{CMPLX(X,[Y,KIND])} returns a complex number where @var{X} is converted to
+@code{CMPLX(X [,Y [,KIND]])} returns a complex number where @var{X} is converted to
 the real component.  If @var{Y} is present it is converted to the imaginary
 component.  If @var{Y} is not present then the imaginary component is set to
 0.0.  If @var{X} is complex then @var{Y} must not be present.
@@ -1506,7 +1506,9 @@
 elemental function
 
 @item @emph{Syntax}:
-@code{C = CMPLX(X[,Y,KIND])}
+@code{C = CMPLX(X)}
+@code{C = CMPLX(X, Y)}
+@code{C = CMPLX(X, Y, KIND)}
 
 @item @emph{Arguments}:
 @multitable @columnfractions .15 .80
@@ -3103,7 +3105,7 @@
 
 @table @asis
 @item @emph{Description}:
-Returns the process numerical identificator of the current process.
+Returns the numerical identifier of the current process.
 
 @item @emph{Option}:
 gnu
@@ -3859,12 +3861,6 @@
 end program test_mod
 @end smallexample
 
-@item @emph{Specific names}:
-@multitable @columnfractions .24 .24 .24 .24
-@item Name             @tab Arguments      @tab Return type    @tab Option
-@item @code{AMOD(A,P)} @tab @code{REAL(4)} @tab @code{REAL(4)} @tab f95, gnu
-@item @code{DMOD(A,P)} @tab @code{REAL(8)} @tab @code{REAL(8)} @tab f95, gnu
-@end multitable
 @end table
 
 
@@ -4373,7 +4369,7 @@
 
 
 @node SECNDS
-@section @code{SECNDS} --- Time subroutine
+@section @code{SECNDS} --- Time function
 @findex @code{SECNDS} intrinsic
 @cindex SECNDS
 
@@ -4604,7 +4600,7 @@
 @end multitable
 
 @item @emph{Return value}:
-The return value has same type and king than @var{X}.
+The return value has same type and kind as @var{X}.
 
 @item @emph{Example}:
 @smallexample


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]