# HG changeset patch # User Rik # Date 1377015935 25200 # Node ID 4d7f95eb8bfef6ef4654b618888d61b8cdf57787 # Parent 88a6f2f540adac25092eb4dab3ace9eb9b39cf7a doc: Miscellaneous small tweaks to documentation for consistency. * doc/interpreter/external.txi: Don't group EXAMPLEFILEs which are longer than 20 lines. * doc/interpreter/oop.txi: Don't group EXAMPLEFILEs which are longer than 20 lines. * doc/interpreter/octave.texi: Eliminate trailing whitespace. * doc/interpreter/tips.txi: Eliminate trailing whitespace. * examples/mysparse.c: Eliminate trailing whitespace. * scripts/miscellaneous/compare_versions.m: use @qcode macro. * scripts/plot/gnuplot_binary.in: use @qcode macro. * scripts/statistics/tests/kruskal_wallis_test.m: use @cite macro. diff -r 88a6f2f540ad -r 4d7f95eb8bfe doc/interpreter/external.txi --- a/doc/interpreter/external.txi Tue Aug 20 09:48:52 2013 -0400 +++ b/doc/interpreter/external.txi Tue Aug 20 09:25:35 2013 -0700 @@ -357,9 +357,7 @@ @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 @@ -484,9 +482,7 @@ example is @example -@group @EXAMPLEFILE(celldemo.cc) -@end group @end example Note that cell arrays are used less often in standard oct-files and so @@ -1517,9 +1513,7 @@ as shown below. @example -@group @EXAMPLEFILE(mycell.c) -@end group @end example @noindent @@ -1737,9 +1731,7 @@ @file{liboctave.so}. @example -@group @EXAMPLEFILE(standalone.cc) -@end group @end example @noindent @@ -1766,9 +1758,7 @@ seen in the code @example -@group @EXAMPLEFILE(embedded.cc) -@end group @end example @noindent diff -r 88a6f2f540ad -r 4d7f95eb8bfe doc/interpreter/octave.texi --- a/doc/interpreter/octave.texi Tue Aug 20 09:48:52 2013 -0400 +++ b/doc/interpreter/octave.texi Tue Aug 20 09:25:35 2013 -0700 @@ -147,54 +147,54 @@ @c ------------------------------------------------------------------------ @menu -* Preface:: +* Preface:: * Introduction:: A brief introduction to Octave. -* Getting Started:: -* Data Types:: -* Numeric Data Types:: -* Strings:: -* Data Containers:: -* Variables:: -* Expressions:: -* Evaluation:: +* Getting Started:: +* Data Types:: +* Numeric Data Types:: +* Strings:: +* Data Containers:: +* Variables:: +* Expressions:: +* Evaluation:: * Statements:: Looping and program flow control. -* Functions and Scripts:: -* Errors and Warnings:: +* Functions and Scripts:: +* Errors and Warnings:: * Debugging:: -* Input and Output:: -* Plotting:: -* Matrix Manipulation:: -* Arithmetic:: +* Input and Output:: +* Plotting:: +* Matrix Manipulation:: +* Arithmetic:: * Linear Algebra:: * Vectorization and Faster Code Execution:: * Nonlinear Equations:: * Diagonal and Permutation Matrices:: * Sparse Matrices:: -* Numerical Integration:: -* Differential Equations:: -* Optimization:: -* Statistics:: -* Sets:: -* Polynomial Manipulations:: +* Numerical Integration:: +* Differential Equations:: +* Optimization:: +* Statistics:: +* Sets:: +* Polynomial Manipulations:: * Interpolation:: * Geometry:: -* Signal Processing:: -* Image Processing:: -* Audio Processing:: -* Object Oriented Programming:: -* GUI Development:: -* System Utilities:: +* Signal Processing:: +* Image Processing:: +* Audio Processing:: +* Object Oriented Programming:: +* GUI Development:: +* System Utilities:: * Java Interface:: * Packages:: * External Code Interface:: * Test and Demo Functions:: -* Tips and Standards:: +* Tips and Standards:: * Contributing Guidelines:: * Obsolete Functions:: * Trouble:: If you have trouble installing Octave. * Installation:: How to configure, compile and install Octave. -* Emacs Octave Support:: -* Grammar and Parser:: +* Emacs Octave Support:: +* Grammar and Parser:: * Copying:: The GNU General Public License. * Concept Index:: An item for each concept. * Function Index:: An item for each documented function. diff -r 88a6f2f540ad -r 4d7f95eb8bfe doc/interpreter/oop.txi --- a/doc/interpreter/oop.txi Tue Aug 20 09:48:52 2013 -0400 +++ b/doc/interpreter/oop.txi Tue Aug 20 09:25:35 2013 -0700 @@ -94,9 +94,7 @@ our polynomial might look like @example -@group @EXAMPLEFILE(@polynomial/polynomial.m) -@end group @end example Note that the return value of the constructor must be the output of @@ -177,9 +175,7 @@ An example of a display method for the polynomial class might be @example -@group @EXAMPLEFILE(@polynomial/display.m) -@end group @end example @noindent @@ -195,9 +191,7 @@ all of the properties of the class. For example: @example -@group @EXAMPLEFILE(@polynomial/get.m) -@end group @end example @noindent @@ -205,9 +199,7 @@ object to modify, and then take property/value pairs to be modified. @example -@group @EXAMPLEFILE(@polynomial/set.m) -@end group @end example @noindent @@ -282,9 +274,7 @@ polynomial class might look like @example -@group @EXAMPLEFILE(@polynomial/subsref.m) -@end group @end example The equivalent functionality for subscripted assignments uses the @@ -647,9 +637,7 @@ polynomial class constructor would be modified to be @example -@group @EXAMPLEFILE(@polynomial/polynomial_superiorto.m) -@end group @end example Note that user classes always have higher precedence than built-in @@ -692,9 +680,7 @@ FIRfilter.m in the class directory. @example -@group @EXAMPLEFILE(@FIRfilter/FIRfilter.m) -@end group @end example As before, the leading comments provide command-line documentation for @@ -758,9 +744,7 @@ to access the fields. The @code{subsref} method may be used for both. @example -@group @EXAMPLEFILE(@FIRfilter/subsref.m) -@end group @end example The @qcode{"()"} case allows us to filter data using the polynomial provided @@ -819,9 +803,7 @@ constructor for this case might be @example -@group @EXAMPLEFILE(@FIRfilter/FIRfilter_aggregation.m) -@end group @end example For our example, the remaining class methods remain unchanged. diff -r 88a6f2f540ad -r 4d7f95eb8bfe doc/interpreter/tips.txi --- a/doc/interpreter/tips.txi Tue Aug 20 09:48:52 2013 -0400 +++ b/doc/interpreter/tips.txi Tue Aug 20 09:25:35 2013 -0700 @@ -562,14 +562,15 @@ @@seealso@{bincoeff, perms@} @@end deftypefn @end example + @noindent which demonstrates most of the concepts discussed above. @iftex This documentation string renders as - @c Note: use the actual output of info below, rather than try and @c reproduce it here to prevent it looking different from how it would @c appear with info. + @example -- Function File: C = nchoosek (N, K) -- Function File: C = nchoosek (SET, K) diff -r 88a6f2f540ad -r 4d7f95eb8bfe examples/mysparse.c --- a/examples/mysparse.c Tue Aug 20 09:48:52 2013 -0400 +++ b/examples/mysparse.c Tue Aug 20 09:25:35 2013 -0700 @@ -11,14 +11,14 @@ double *pr2, *pi2; mwIndex *ir, *jc; mwIndex *ir2, *jc2; - + if (nrhs != 1 || ! mxIsSparse (prhs[0])) mexErrMsgTxt ("ARG1 must be a sparse matrix"); m = mxGetM (prhs[0]); n = mxGetN (prhs[0]); nz = mxGetNzmax (prhs[0]); - + if (mxIsComplex (prhs[0])) { mexPrintf ("Matrix is %d-by-%d complex sparse matrix", m, n); @@ -40,7 +40,7 @@ pi2 = mxGetPi (v); ir2 = mxGetIr (v); jc2 = mxGetJc (v); - + for (i = 0; i < nz; i++) { pr2[i] = 2 * pr[i]; @@ -72,7 +72,7 @@ pbr2 = mxGetLogicals (v); ir2 = mxGetIr (v); jc2 = mxGetJc (v); - + for (i = 0; i < nz; i++) { pbr2[i] = pbr[i]; @@ -102,7 +102,7 @@ pr2 = mxGetPr (v); ir2 = mxGetIr (v); jc2 = mxGetJc (v); - + for (i = 0; i < nz; i++) { pr2[i] = 2 * pr[i]; diff -r 88a6f2f540ad -r 4d7f95eb8bfe scripts/miscellaneous/compare_versions.m --- a/scripts/miscellaneous/compare_versions.m Tue Aug 20 09:48:52 2013 -0400 +++ b/scripts/miscellaneous/compare_versions.m Tue Aug 20 09:25:35 2013 -0700 @@ -22,51 +22,51 @@ ## ## This function assumes that versions @var{v1} and @var{v2} are ## arbitrarily long strings made of numeric and period characters -## possibly followed by an arbitrary string (e.g., "1.2.3", "0.3", -## "0.1.2+", or "1.2.3.4-test1"). +## possibly followed by an arbitrary string (e.g., @qcode{"1.2.3"}, +## @qcode{"0.3"}, @qcode{"0.1.2+"}, or @qcode{"1.2.3.4-test1"}). ## ## The version is first split into numeric and character portions -## and then the parts are padded to be the same length (i.e., "1.1" would be -## padded to be "1.1.0" when being compared with "1.1.1", and -## separately, the character parts of the strings are padded with -## nulls). +## and then the parts are padded to be the same length (i.e., @qcode{"1.1"} +## would be padded to be @qcode{"1.1.0"} when being compared with +## @qcode{"1.1.1"}, and separately, the character parts of the strings are +## padded with nulls). ## ## The operator can be any logical operator from the set ## ## @itemize @bullet ## @item -## "==" +## @qcode{"=="} ## equal ## ## @item -## "<" +## @qcode{"<"} ## less than ## ## @item -## "<=" +## @qcode{"<="} ## less than or equal to ## ## @item -## ">" +## @qcode{">"} ## greater than ## ## @item -## ">=" +## @qcode{">="} ## greater than or equal to ## ## @item -## "!=" +## @qcode{"!="} ## not equal ## ## @item -## "~=" +## @qcode{"~="} ## not equal ## @end itemize ## -## Note that version "1.1-test2" will compare as greater than -## "1.1-test10". Also, since the numeric part is compared first, "a" -## compares less than "1a" because the second string starts with a -## numeric part even though @code{double ("a")} is greater than +## Note that version @qcode{"1.1-test2"} will compare as greater than +## @qcode{"1.1-test10"}. Also, since the numeric part is compared first, +## @qcode{"a"} compares less than @qcode{"1a"} because the second string +## starts with a numeric part even though @code{double ("a")} is greater than ## @code{double ("1").} ## @end deftypefn diff -r 88a6f2f540ad -r 4d7f95eb8bfe scripts/plot/gnuplot_binary.in --- a/scripts/plot/gnuplot_binary.in Tue Aug 20 09:48:52 2013 -0400 +++ b/scripts/plot/gnuplot_binary.in Tue Aug 20 09:25:35 2013 -0700 @@ -22,7 +22,7 @@ ## Query or set the name of the program invoked by the plot command ## when the graphics toolkit is set to "gnuplot". Additional arguments to ## pass to the external plotting program may also be given. -## The default value is @code{"gnuplot"} with no additional arguments. +## The default value is @qcode{"gnuplot"} with no additional arguments. ## @xref{Installation}. ## @seealso{graphics_toolkit} ## @end deftypefn diff -r 88a6f2f540ad -r 4d7f95eb8bfe scripts/statistics/tests/kruskal_wallis_test.m --- a/scripts/statistics/tests/kruskal_wallis_test.m Tue Aug 20 09:48:52 2013 -0400 +++ b/scripts/statistics/tests/kruskal_wallis_test.m Tue Aug 20 09:25:35 2013 -0700 @@ -36,9 +36,10 @@ ## where @var{sum_ties} is the sum of @var{t}^2 - @var{t} over each group ## of ties where @var{t} is the number of ties in the group and @var{n} ## is the total number of values in the input data. For more info on -## this adjustment see "Use of Ranks in One-Criterion Variance Analysis" -## in Journal of the American Statistical Association, Vol. 47, -## No. 260 (Dec 1952) by William H. Kruskal and W. Allen Wallis. +## this adjustment see William H. Kruskal and W. Allen Wallis, +## @cite{Use of Ranks in One-Criterion Variance Analysis}, +## Journal of the American Statistical Association, Vol. 47, +## No. 260 (Dec 1952). ## ## The p-value (1 minus the CDF of this distribution at @var{k}) is ## returned in @var{pval}.