Mercurial > octave
changeset 21316:6cc091426e52
doc: Periodic grammarcheck of documentation.
* external.txi, munge-texi.pl, psi.cc, inputParser.m, orderfields.m:
Periodic grammarcheck of documentation.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sun, 21 Feb 2016 07:43:16 -0800 |
| parents | ea2c2e08ceda |
| children | a4faec57f4c8 |
| files | doc/interpreter/external.txi doc/interpreter/munge-texi.pl libinterp/corefcn/psi.cc scripts/general/inputParser.m scripts/miscellaneous/orderfields.m |
| diffstat | 5 files changed, 18 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/external.txi Sat Feb 20 15:26:24 2016 -0800 +++ b/doc/interpreter/external.txi Sun Feb 21 07:43:16 2016 -0800 @@ -356,7 +356,9 @@ @w{@code{DEFUN_DLD}} function is as follows @example +@group @EXAMPLEFILE(addtwomatrices.cc) +@end group @end example To avoid segmentation faults causing Octave to abort this function
--- a/doc/interpreter/munge-texi.pl Sat Feb 20 15:26:24 2016 -0800 +++ b/doc/interpreter/munge-texi.pl Sun Feb 21 07:43:16 2016 -0800 @@ -77,7 +77,7 @@ print "\n" if (eof and substr ($_, -1) ne "\n"); } close (EXAMPFH); - print '@end verbatim',"\n\n"; + print '@end verbatim',"\n"; next TXI_LINE; }
--- a/libinterp/corefcn/psi.cc Sat Feb 20 15:26:24 2016 -0800 +++ b/libinterp/corefcn/psi.cc Sun Feb 21 07:43:16 2016 -0800 @@ -51,11 +51,13 @@ $$\n\ @end tex\n\ @ifnottex\n\ +\n\ @example\n\ @group\n\ psi (z) = d (log (gamma (z))) / dx\n\ @end group\n\ @end example\n\ +\n\ @end ifnottex\n\ \n\ When computing the digamma function (when @var{k} equals zero), @var{z}\n\
--- a/scripts/general/inputParser.m Sat Feb 20 15:26:24 2016 -0800 +++ b/scripts/general/inputParser.m Sun Feb 21 07:43:16 2016 -0800 @@ -108,7 +108,10 @@ ## ## for example, get the tolerance input with p.Results.tolerance ## endfunction ## @end group +## @end example ## +## @example +## @group ## check ("mech"); # valid, use defaults for other arguments ## check (); # error, one argument is mandatory ## check (1); # error, since ! ischar @@ -124,6 +127,7 @@ ## ## following returns an error since not all optional arguments, ## ## `path' and `mat', were given before the named argument `type'. ## check ("mech", "~/dev", "type", "linear"); +## @end group ## @end example ## ## @emph{Note 1}: A function can have any mixture of the four API types but
--- a/scripts/miscellaneous/orderfields.m Sat Feb 20 15:26:24 2016 -0800 +++ b/scripts/miscellaneous/orderfields.m Sun Feb 21 07:43:16 2016 -0800 @@ -49,6 +49,9 @@ ## d = 4 ## @} ## @end group +## @end example +## +## @example ## @group ## t = struct ("d", @{@}, "c", @{@}, "b", @{@}, "a", @{@}); ## t2 = orderfields (s, t) @@ -60,6 +63,9 @@ ## a = 1 ## @} ## @end group +## @end example +## +## @example ## @group ## t3 = orderfields (s, [3, 2, 4, 1]) ## @result{} t3 = @@ -70,6 +76,9 @@ ## d = 4 ## @} ## @end group +## @end example +## +## @example ## @group ## [t4, p] = orderfields (s, @{"d", "c", "b", "a"@}) ## @result{} t4 =