changeset 25032:a1e391e33004 stable

doc: grammarcheck documentation again ahead of 4.4 release. * preface.txi, data.cc, file-io.cc, symrcm.cc, sinint.m: Use Octave documentation conventions.
author Rik <rik@octave.org>
date Tue, 27 Mar 2018 20:46:43 -0700
parents 62186547b752
children 336c167b1883
files doc/interpreter/preface.txi libinterp/corefcn/data.cc libinterp/corefcn/file-io.cc libinterp/dldfcn/symrcm.cc scripts/specfun/sinint.m
diffstat 5 files changed, 9 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/preface.txi	Thu Mar 22 08:18:27 2018 +0100
+++ b/doc/interpreter/preface.txi	Tue Mar 27 20:46:43 2018 -0700
@@ -170,8 +170,8 @@
 There are a number of ways that you can contribute to help make Octave a
 better system.  Perhaps the most important way to contribute is to write
 high-quality code for solving new problems, and to make your code freely
-available for others to use.  See @url{https://www.octave.org/get-involved.html}
-for detailed information.
+available for others to use.  See
+@url{https://www.octave.org/get-involved.html} for detailed information.
 
 If you find Octave useful, consider providing additional funding to
 continue its development.  Even a modest amount of additional funding
--- a/libinterp/corefcn/data.cc	Thu Mar 22 08:18:27 2018 +0100
+++ b/libinterp/corefcn/data.cc	Tue Mar 27 20:46:43 2018 -0700
@@ -6287,7 +6287,7 @@
 When given the identifier @var{id} of a specific timer, return the number of
 seconds elapsed since the timer @var{id} was initialized.
 
-@xref{XREFtic, , tic}, for examples of the use of @code{tic}/@code{toc}. 
+@xref{XREFtic, , tic}, for examples of the use of @code{tic}/@code{toc}.
 
 @seealso{tic, cputime}
 @end deftypefn */)
--- a/libinterp/corefcn/file-io.cc	Thu Mar 22 08:18:27 2018 +0100
+++ b/libinterp/corefcn/file-io.cc	Tue Mar 27 20:46:43 2018 -0700
@@ -3088,7 +3088,7 @@
 
 DEFUNX ("SEEK_SET", FSEEK_SET, args, ,
         doc: /* -*- texinfo -*-
-@deftypefn  {} {} SEEK_SET ()
+@deftypefn {} {} SEEK_SET ()
 Return the numerical value to pass to @code{fseek} to position the file pointer
 relative to the beginning of the file.
 @seealso{SEEK_CUR, SEEK_END, fseek}
--- a/libinterp/dldfcn/symrcm.cc	Thu Mar 22 08:18:27 2018 +0100
+++ b/libinterp/dldfcn/symrcm.cc	Tue Mar 27 20:46:43 2018 -0700
@@ -432,8 +432,9 @@
 minimization problem.  The implementation is based in the descriptions found
 in
 
-@nospell{E. Cuthill, J. McKee}. @cite{Reducing the Bandwidth of Sparse
-Symmetric Matrices}. Proceedings of the 24th @nospell{ACM} National Conference,
+@nospell{E. Cuthill, J. McKee}.
+@cite{Reducing the Bandwidth of Sparse Symmetric Matrices}.
+Proceedings of the 24th @nospell{ACM} National Conference,
 157--172 1969, Brandon Press, New Jersey.
 
 @nospell{A. George, J.W.H. Liu}. @cite{Computer Solution of Large Sparse
--- a/scripts/specfun/sinint.m	Thu Mar 22 08:18:27 2018 +0100
+++ b/scripts/specfun/sinint.m	Tue Mar 27 20:46:43 2018 -0700
@@ -38,7 +38,8 @@
 ##
 ## @end ifnottex
 ##
-## Reference: @nospell{M. Abramowitz and I.A. Stegun},
+## Reference:
+## @nospell{M. Abramowitz and I.A. Stegun},
 ## @cite{Handbook of Mathematical Functions}, 1964.
 ##
 ## @seealso{cosint, expint, sin}