Mercurial > octave
changeset 23565:3a730821e4a2
doc: Peridoc grammarcheck of documentation.
* container.txi, external.txi, install.txi, oop.txi, plot.txi, testfun.txi,
eig.cc, graphics.cc, gsvd.cc, hex2num.cc, pr-output.cc, sub2ind.cc,
__ode15__.cc, Map.m, __publish_html_output__.m, __publish_latex_output__.m,
odeset.m, ode_event_handler.m, runge_kutta_45_dorpri.m, xlim.m, ylim.m, zlim.m,
hgtransform.m, eigs.m, native2unicode.m, unicode2native.m:
grammarcheck documentation.
line wrap: on
line diff
--- a/doc/interpreter/container.txi Thu Jun 08 15:56:46 2017 -0700 +++ b/doc/interpreter/container.txi Thu Jun 08 17:41:32 2017 -0700 @@ -1045,7 +1045,6 @@ generated with @code{@{@}} can be assigned to. An example is @example -@group in@{1@} = [10, 20, 30]; in@{2@} = inf; in@{3@} = "last"; @@ -1068,7 +1067,6 @@ [5,1] = Inf [6,1] = first @} -@end group @end example
--- a/doc/interpreter/external.txi Thu Jun 08 15:56:46 2017 -0700 +++ b/doc/interpreter/external.txi Thu Jun 08 17:41:32 2017 -0700 @@ -1978,6 +1978,7 @@ The example above can be carried out using only Java objects: @example +@group a = javaObject ("java.lang.Double", 1.001); b = javaObject ("java.math.BigDecimal", a); @@ -1989,6 +1990,7 @@ @result{} ans = 1 class (b) @result{} ans = java.math.BigDecimal +@end group @end example One can see, that even a @code{java.lang.Double} is not converted to an Octave
--- a/doc/interpreter/install.txi Thu Jun 08 15:56:46 2017 -0700 +++ b/doc/interpreter/install.txi Thu Jun 08 17:41:32 2017 -0700 @@ -360,16 +360,20 @@ @item --disable-64 Disable using 64-bit integers for indexing arrays and use 32-bit integers instead. On systems with 32-bit pointers, this option is -always disabled. If he configure script determines that your BLAS +always disabled. If the configure script determines that your @sc{blas} library uses 32-bit integers, then operations using the following libraries are limited to arrays with dimensions that are smaller than @math{2^{31}} elements: @itemize @bullet @item @sc{blas} + @item @sc{lapack} + @item QRUPDATE + @item SuiteSparse + @item @sc{arpack} @end itemize @@ -378,6 +382,7 @@ @itemize @bullet @item @sc{glpk} + @item Qhull @end itemize @@ -385,8 +390,8 @@ about building Octave with more complete support for large arrays. @item --enable-address-sanitizer-flags -Enable compiler options @code{-fsanitize=address} and -@code{-fomit-frame-pointer} for memory access checking. This option is +Enable compiler options @option{-fsanitize=address} and +@option{-fomit-frame-pointer} for memory access checking. This option is primarily used for debugging Octave. Building Octave with this option has a negative impact on performance and is not recommended for general use. It may also interfere with proper functioning of the GUI. @@ -630,16 +635,20 @@ 32-bit system have a 64-bit address space. On 64-bit systems, Octave uses 64-bit integers for indexing arrays -by default. If he configure script determines that your BLAS +by default. If the configure script determines that your @sc{blas} library uses 32-bit integers, then operations using the following libraries are limited to arrays with dimensions that are smaller than @math{2^{31}} elements: @itemize @bullet @item @sc{blas} + @item @sc{lapack} + @item QRUPDATE + @item SuiteSparse + @item @sc{arpack} @end itemize @@ -648,6 +657,7 @@ @itemize @bullet @item @sc{glpk} + @item Qhull @end itemize
--- a/doc/interpreter/oop.txi Thu Jun 08 15:56:46 2017 -0700 +++ b/doc/interpreter/oop.txi Thu Jun 08 17:41:32 2017 -0700 @@ -531,7 +531,7 @@ @item @code{a.'} @tab @code{transpose (a)} @tab Transpose @item @code{a:b} @tab @code{colon (a, b)} @tab Two element range @item @code{a:b:c} @tab @code{colon (a, b, c)} @tab Three element range -@item @code{[a, b]} @tab @code{horzcat (a, b)} @tab Horizontal concatenation +@item @code{[a, b]} @tab @code{horzcat (a, b)} @tab Horizontal concatenation @item @code{[a; b]} @tab @code{vertcat (a, b)} @tab Vertical concatenation @item @code{a(s@math{_1},@dots{},s@math{_n})} @tab @code{subsref (a, s)} @tab Subscripted reference @item @code{a(s@math{_1},@dots{},s@math{_n}) = b} @tab @code{subsasgn (a, s, b)} @tab Subscripted assignment @@ -771,7 +771,7 @@ @b{access rights} for properties and methods, @item -@b{static methods}, i.e. methods that are independent of an object, and +@b{static methods}, i.e., methods that are independent of an object, and @item the distinction between @b{value and handle classes}. @@ -828,10 +828,12 @@ constructor: @example +@group >> p = polynomial2 ([1, 0, 1]) @result{} p = 1 + X ^ 2 +@end group @end example @node Properties @@ -897,11 +899,10 @@ All class methods must be defined within @code{methods} blocks. An exception to this rule is described at the end of this subsection. Those @code{methods} blocks can have additional attributes specifying the access rights or whether -the methods are static, i.e. methods that can be called without creating an +the methods are static, i.e., methods that can be called without creating an object of that class. @example -@group classdef some_class methods function obj = some_class () @@ -925,7 +926,6 @@ endfunction endmethods endclassdef -@end group @end example The constructor of the class is declared in the @code{methods} block and must @@ -942,10 +942,12 @@ ("@code{.}") and the method's name with subsequent arguments: @example +@group >> obj = some_class (); New instance created. >> disp (obj); # both are >> obj.disp (); # equal +@end group @end example In @code{some_class}, the method @code{func} is defined within a @code{methods}
--- a/doc/interpreter/plot.txi Thu Jun 08 15:56:46 2017 -0700 +++ b/doc/interpreter/plot.txi Thu Jun 08 17:41:32 2017 -0700 @@ -221,8 +221,10 @@ and linear. For example, @example +@group polar (0:0.1:10*pi, 0:0.1:10*pi); title ("Example polar plot from 0 to 10*pi"); +@end group @end example @noindent @@ -1812,7 +1814,7 @@ gives some event specific data. The function can be provided as a function handle to a plain Octave function, -as an anonymous function or as a string representing an Octvae command. The +as an anonymous function or as a string representing an Octave command. The latter syntax is not recommended since syntax errors will only occur when the string is evaluated. @xref{Function Handles Anonymous Functions Inline Functions, , Function Handles section}.
--- a/doc/interpreter/testfun.txi Thu Jun 08 15:56:46 2017 -0700 +++ b/doc/interpreter/testfun.txi Thu Jun 08 17:41:32 2017 -0700 @@ -331,22 +331,22 @@ @subsubheading Block type summary: @table @code -@item %!test +@item %!test @itemx %!test <MESSAGE> Check that entire block is correct. If @code{<MESSAGE>} is present, the test block is interpreted as for @code{xtest}. -@item %!testif HAVE_XXX +@item %!testif HAVE_XXX @itemx %!testif HAVE_XXX, HAVE_YYY, @dots{} @itemx %!testif HAVE_XXX, HAVE_YYY @dots{}; RUNTIME_COND @itemx %!testif @dots{} <MESSAGE> -Check block only if Octave was compiled with feature @code{HAVE_XXX}. -@code{RUNTIME_COND} is an optional expression to evaluate to check +Check block only if Octave was compiled with feature @w{@code{HAVE_XXX}}. +@w{@code{RUNTIME_COND}} is an optional expression to evaluate to check whether some condition is met when the test is executed. If -@code{RUNTIME_COND} is false, the test is skipped. If @code{<MESSAGE>} +@w{@code{RUNTIME_COND}} is false, the test is skipped. If @code{<MESSAGE>} is present, the test block is interpreted as for @code{xtest}. -@item %!xtest +@item %!xtest @itemx %!xtest <MESSAGE> Check block, report a test failure but do not abort testing. If @code{<MESSAGE>} is present, then the text of the message is displayed @@ -368,7 +368,7 @@ in which BUG-ID is the integer bug number. The intent is to allow clearer documentation of known problems. -@item %!error +@item %!error @itemx %!error <MESSAGE> @itemx %!warning @itemx %!warning <MESSAGE> @@ -392,8 +392,11 @@ Close a function definition. @item %!assert (x, y, tol) + @item %!assert <MESSAGE> (x, y, tol) + @item %!fail (CODE, PATTERN) + @item %!fail <MESSAGE> (CODE, PATTERN) Shorthand for @code{%!test assert (x, y, tol)} or @code{%!test fail (CODE, PATTERN)}. If @code{<MESSAGE>} is present, the
--- a/libinterp/corefcn/eig.cc Thu Jun 08 15:56:46 2017 -0700 +++ b/libinterp/corefcn/eig.cc Thu Jun 08 17:41:32 2017 -0700 @@ -46,14 +46,13 @@ @deftypefnx {} {[@dots{}] =} eig (@var{A}, @var{B}, @var{algorithm}) @deftypefnx {} {[@dots{}] =} eig (@dots{}, @var{eigvalOption}) Compute the eigenvalues (@var{lambda}) and optionally the right eigenvectors -(@var{V}) and the left eigenvectors (@var{W}) of a matrix or a pair of -matrices. +(@var{V}) and the left eigenvectors (@var{W}) of a matrix or pair of matrices. The flag @var{balanceOption} can be one of: @table @asis -@item @qcode{"balance"} -Preliminary balancing is on. (default) +@item @qcode{"balance"} (default) +Preliminary balancing is on. @item @qcode{"nobalance"} Disables preliminary balancing. @@ -63,24 +62,23 @@ @table @asis @item @qcode{"matrix"} -Return the eigenvalues in a diagonal matrix. (default if 2 or 3 outputs -are specified) +Return the eigenvalues in a diagonal matrix. (default if 2 or 3 outputs +are requested) @item @qcode{"vector"} -Return the eigenvalues in a column vector. (default if 1 output is -specified, e.g. @var{lambda} = eig (@var{A})) +Return the eigenvalues in a column vector. (default if only 1 output is +requested, e.g., @var{lambda} = eig (@var{A})) @end table The flag @var{algorithm} can be one of: @table @asis @item @qcode{"chol"} -Uses the Cholesky factorization of B. (default if A is symmetric (Hermitian) -and B is symmetric (Hermitian) positive definite) +Use the Cholesky factorization of B. (default if @var{A} is symmetric +(Hermitian) and @var{B} is symmetric (Hermitian) positive definite) @item @qcode{"qz"} -Uses the QZ algorithm. (When A or B are not symmetric always the -QZ algorithm will be used) +Use the QZ algorithm. (used whenever @var{A} or @var{B} are not symmetric) @end table @multitable @columnfractions .31 .23 .23 .23
--- a/libinterp/corefcn/graphics.cc Thu Jun 08 15:56:46 2017 -0700 +++ b/libinterp/corefcn/graphics.cc Thu Jun 08 17:41:32 2017 -0700 @@ -12098,19 +12098,21 @@ DEFUN (__get_frame__, args, , doc: /* -*- texinfo -*- -@deftypefn {} {@var{cdata} = } __get_frame__ (@var{hfig}) -Internal function: returns the pixel cdata of figure hfig in the form of a -height-by-width-by-3 uint8 array +@deftypefn {} {@var{cdata} =} __get_frame__ (@var{hfig}) +Internal function. + +Return the pixel cdata of figure hfig in the form of a height-by-width-by-3 +uint8 array. @end deftypefn */) { if (args.length () != 1) print_usage (); - double h = args(0).xdouble_value ("__get_frame__: argument is not a handle"); + double h = args(0).xdouble_value ("__get_frame__: HFIG is not a handle"); graphics_object go = gh_manager::get_object (h); if (! go || ! go.isa ("figure")) - error ("__get_frame__: object is not a figure"); + error ("__get_frame__: HFIG is not a figure"); return ovl (go.get_toolkit ().get_pixels (go)); }
--- a/libinterp/corefcn/gsvd.cc Thu Jun 08 15:56:46 2017 -0700 +++ b/libinterp/corefcn/gsvd.cc Thu Jun 08 17:41:32 2017 -0700 @@ -118,7 +118,8 @@ @end ifnottex -The function @code{gsvd} normally returns just the vector of generalized singular values +The function @code{gsvd} normally returns just the vector of generalized +singular values @tex $$ \sqrt{{{diag (C^\dagger C)} \over {diag (S^\dagger S)}}} $$ @end tex
--- a/libinterp/corefcn/hex2num.cc Thu Jun 08 15:56:46 2017 -0700 +++ b/libinterp/corefcn/hex2num.cc Thu Jun 08 17:41:32 2017 -0700 @@ -265,7 +265,7 @@ DEFUN (num2hex, args, , doc: /* -*- texinfo -*- -@deftypefn {} {@var{s} =} num2hex (@var{n}) +@deftypefn {} {@var{s} =} num2hex (@var{n}) @deftypefnx {} {@var{s} =} num2hex (@var{n}, "cell") Convert a numeric array to an array of hexadecimal strings.
--- a/libinterp/corefcn/pr-output.cc Thu Jun 08 15:56:46 2017 -0700 +++ b/libinterp/corefcn/pr-output.cc Thu Jun 08 17:41:32 2017 -0700 @@ -3572,7 +3572,7 @@ DEFUN (display, args, , classes: cell char double function_handle int8 int16 int32 int64 logical single struct uint8 uint16 uint32 uint64 doc: /* -*- texinfo -*- -@deftypefn {} {} display (@var{obj}) +@deftypefn {} {} display (@var{obj}) Display the contents of the object @var{obj} prepended by its name. The Octave interpreter calls the @code{display} function whenever it needs
--- a/libinterp/corefcn/sub2ind.cc Thu Jun 08 15:56:46 2017 -0700 +++ b/libinterp/corefcn/sub2ind.cc Thu Jun 08 17:41:32 2017 -0700 @@ -76,8 +76,8 @@ @code{ind2sub} and @code{sub2ind} interconvert between the two forms. The linear index traverses dimension 1 (rows), then dimension 2 (columns), then -dimension 3 (pages), etc. until it has numbered all of the elements. Consider -the following 3-by-3 matrices: +dimension 3 (pages), etc.@: until it has numbered all of the elements. +Consider the following 3-by-3 matrices: @example @group @@ -200,8 +200,8 @@ @code{ind2sub} and @code{sub2ind} interconvert between the two forms. The linear index traverses dimension 1 (rows), then dimension 2 (columns), then -dimension 3 (pages), etc. until it has numbered all of the elements. Consider -the following 3-by-3 matrices: +dimension 3 (pages), etc.@: until it has numbered all of the elements. +Consider the following 3-by-3 matrices: @example @group
--- a/libinterp/dldfcn/__ode15__.cc Thu Jun 08 15:56:46 2017 -0700 +++ b/libinterp/dldfcn/__ode15__.cc Thu Jun 08 17:41:32 2017 -0700 @@ -1113,7 +1113,7 @@ DEFUN_DLD (__ode15__, args, , doc: /* -*- texinfo -*- -@deftypefn {} {@var{t}, @var{y} =} __ode15__ (@var{fun}, @var{tspan}, @var{y0}, @var{yp0}, @var{options}) +@deftypefn {} {@var{t}, @var{y} =} __ode15__ (@var{fun}, @var{tspan}, @var{y0}, @var{yp0}, @var{options}) Undocumented internal function. @end deftypefn */) {
--- a/scripts/+containers/Map.m Thu Jun 08 15:56:46 2017 -0700 +++ b/scripts/+containers/Map.m Thu Jun 08 17:41:32 2017 -0700 @@ -38,7 +38,7 @@ ## When called with no input arguments a default map is created with strings ## as the key type and @qcode{"any"} as the value type. ## -## The @qcode{"UniformValues"} option specifies specifies whether the values of +## The @qcode{"UniformValues"} option specifies whether the values of ## the map must be strictly of the same type. If @var{is_uniform} is true, any ## values which would be added to the map are first validated to ensure they ## are of the correct type.
--- a/scripts/general/private/__publish_html_output__.m Thu Jun 08 15:56:46 2017 -0700 +++ b/scripts/general/private/__publish_html_output__.m Thu Jun 08 17:41:32 2017 -0700 @@ -30,42 +30,61 @@ ## @itemize @bullet ## @item ## @samp{output_file_extension} () +## ## @item ## @samp{header} (title_str, intro_str, toc_cstr) +## ## @item ## @samp{footer} () +## ## @item ## @samp{code} (str) +## ## @item ## @samp{code_output} (str) +## ## @item ## @samp{section} (str) +## ## @item ## @samp{preformatted_code} (str) +## ## @item ## @samp{preformatted_text} (str) +## ## @item ## @samp{bulleted_list} (cstr) +## ## @item ## @samp{numbered_list} (cstr) +## ## @item ## @samp{graphic} (str) +## ## @item ## @samp{html} (str) +## ## @item ## @samp{latex} (str) +## ## @item ## @samp{text} (str) +## ## @item ## @samp{bold} (str) +## ## @item ## @samp{italic} (str) +## ## @item ## @samp{monospaced} (str) +## ## @item ## @samp{link} (url_str, url_str, str) +## ## @item ## @samp{TM} () +## ## @item ## @samp{R} () ## @end itemize
--- a/scripts/general/private/__publish_latex_output__.m Thu Jun 08 15:56:46 2017 -0700 +++ b/scripts/general/private/__publish_latex_output__.m Thu Jun 08 17:41:32 2017 -0700 @@ -23,49 +23,68 @@ ## ## The first input argument @var{type} defines the required strings ## (@samp{str}) or cell-strings (@samp{cstr}) in @var{varargin} in order -## to produce LaTeX output. +## to produce @LaTeX{} output. ## ## @var{type} is one of ## ## @itemize @bullet ## @item ## @samp{output_file_extension} () +## ## @item ## @samp{header} (title_str, intro_str, toc_cstr) +## ## @item ## @samp{footer} () +## ## @item ## @samp{code} (str) +## ## @item ## @samp{code_output} (str) +## ## @item ## @samp{section} (str) +## ## @item ## @samp{preformatted_code} (str) +## ## @item ## @samp{preformatted_text} (str) +## ## @item ## @samp{bulleted_list} (cstr) +## ## @item ## @samp{numbered_list} (cstr) +## ## @item ## @samp{graphic} (str) +## ## @item ## @samp{html} (str) +## ## @item ## @samp{latex} (str) +## ## @item ## @samp{text} (str) +## ## @item ## @samp{bold} (str) +## ## @item ## @samp{italic} (str) +## ## @item ## @samp{monospaced} (str) +## ## @item ## @samp{link} (url_str, url_str, str) +## ## @item ## @samp{TM} () +## ## @item ## @samp{R} () ## @end itemize
--- a/scripts/ode/odeset.m Thu Jun 08 15:56:46 2017 -0700 +++ b/scripts/ode/odeset.m Thu Jun 08 17:41:32 2017 -0700 @@ -52,7 +52,7 @@ ## @var{oldstruct}. ## ## The most commonly used ODE options, which are always assigned a value -## by @qcode{odeset}, are the following: +## by @code{odeset}, are the following: ## ## @table @asis ## @item AbsTol @@ -63,7 +63,7 @@ ## @emph{Note}: This option is not yet implemented. ## ## @item Events -## Event function. An event function must have the form +## Event function. An event function must have the form ## @code{[value, isterminal, direction] = my_events_f (t, y)} ## ## @item InitialSlope @@ -89,7 +89,7 @@ ## time and state. ## ## @item MassSingular -## Specify whether the mass matrix is singular. Accepted values include +## Specify whether the mass matrix is singular. Accepted values include ## @qcode{"yes"}, @qcode{"no"}, @qcode{"maybe"}. ## ## @item MaxOrder @@ -108,15 +108,15 @@ ## ## @item NonNegative ## Specify elements of the state vector that are expected to remain -## nonnegative during the simulation. +## non-negative during the simulation. ## ## @item NormControl ## Control error relative to the 2-norm of the solution, rather than its ## absolute value. ## ## @item OutputFcn -## Function to monitor the state during the simulation. For the form of -## the function to use see @qcode{odeplot}. +## Function to monitor the state during the simulation. For the form of +## the function to use see @code{odeplot}. ## ## @item OutputSel ## Indices of elements of the state vector to be passed to the output @@ -124,7 +124,7 @@ ## ## @item Refine ## Specify whether output should be returned only at the end of each -## time step or also at intermediate time instances. The value should be +## time step or also at intermediate time instances. The value should be ## a scalar indicating the number of equally spaced time points to use ## within each timestep at which to return output. ## @emph{Note}: This option is not yet implemented. @@ -136,7 +136,7 @@ ## Print solver statistics after simulation. ## ## @item Vectorized -## Specify whether @qcode{odefun} can be passed multiple values of the +## Specify whether @code{odefun} can be passed multiple values of the ## state at once. ## ## @end table
--- a/scripts/ode/private/ode_event_handler.m Thu Jun 08 15:56:46 2017 -0700 +++ b/scripts/ode/private/ode_event_handler.m Thu Jun 08 17:41:32 2017 -0700 @@ -21,7 +21,7 @@ ## ## Return the solution of the event function (@var{@@evtfun}) which is ## specified in the form of a function handle. -# +## ## The second input argument @var{t} is a scalar double and specifies the time ## of the event evaluation. ##
--- a/scripts/ode/private/runge_kutta_45_dorpri.m Thu Jun 08 15:56:46 2017 -0700 +++ b/scripts/ode/private/runge_kutta_45_dorpri.m Thu Jun 08 17:41:32 2017 -0700 @@ -19,9 +19,9 @@ ## -*- texinfo -*- ## @deftypefn {} {[@var{t_next}, @var{x_next}] =} runge_kutta_45_dorpri (@var{@@fun}, @var{t}, @var{x}, @var{dt}) -## @deftypefn {} {[@var{t_next}, @var{x_next}] =} runge_kutta_45_dorpri (@var{@@fun}, @var{t}, @var{x}, @var{dt}, @var{options}) -## @deftypefn {} {[@var{t_next}, @var{x_next}] =} runge_kutta_45_dorpri (@var{@@fun}, @var{t}, @var{x}, @var{dt}, @var{options}, @var{k_vals}) -## @deftypefn {} {[@var{t_next}, @var{x_next}] =} runge_kutta_45_dorpri (@var{@@fun}, @var{t}, @var{x}, @var{dt}, @var{options}, @var{k_vals}, @var{t_next}) +## @deftypefnx {} {[@var{t_next}, @var{x_next}] =} runge_kutta_45_dorpri (@var{@@fun}, @var{t}, @var{x}, @var{dt}, @var{options}) +## @deftypefnx {} {[@var{t_next}, @var{x_next}] =} runge_kutta_45_dorpri (@var{@@fun}, @var{t}, @var{x}, @var{dt}, @var{options}, @var{k_vals}) +## @deftypefnx {} {[@var{t_next}, @var{x_next}] =} runge_kutta_45_dorpri (@var{@@fun}, @var{t}, @var{x}, @var{dt}, @var{options}, @var{k_vals}, @var{t_next}) ## @deftypefnx {} {[@var{t_next}, @var{x_next}, @var{x_est}] =} runge_kutta_45_dorpri (@dots{}) ## @deftypefnx {} {[@var{t_next}, @var{x_next}, @var{x_est}, @var{k_vals_out}] =} runge_kutta_45_dorpri (@dots{}) ##
--- a/scripts/plot/appearance/xlim.m Thu Jun 08 15:56:46 2017 -0700 +++ b/scripts/plot/appearance/xlim.m Thu Jun 08 17:41:32 2017 -0700 @@ -28,8 +28,8 @@ ## Called without arguments @code{xlim} returns the x-axis limits of the ## current plot. ## -## With the input query @qcode{"mode"}, return the current x-limit -## calculation mode which is either @qcode{"auto"} or @qcode{"manual"}. +## With the input query @qcode{"mode"}, return the current x-limit calculation +## mode which is either @qcode{"auto"} or @qcode{"manual"}. ## ## If passed a 2-element vector [@var{x_lo} @var{x_hi}], the limits of the ## x-axis are set to these values and the mode is set to @qcode{"manual"}. @@ -44,8 +44,7 @@ ## ## Programming Note: The @code{xlim} function operates by modifying the ## @qcode{"xlim"} and @qcode{"xlimmode"} properties of an axes object. These -## properties can be be directly inspected and altered with -## @code{get}/@code{set}. +## properties can be directly inspected and altered with @code{get}/@code{set}. ## @seealso{ylim, zlim, axis, set, get, gca} ## @end deftypefn
--- a/scripts/plot/appearance/ylim.m Thu Jun 08 15:56:46 2017 -0700 +++ b/scripts/plot/appearance/ylim.m Thu Jun 08 17:41:32 2017 -0700 @@ -28,8 +28,8 @@ ## Called without arguments @code{ylim} returns the y-axis limits of the ## current plot. ## -## With the input query @qcode{"mode"}, return the current -## y-limit calculation mode which is either @qcode{"auto"} or @qcode{"manual"}. +## With the input query @qcode{"mode"}, return the current y-limit calculation +## mode which is either @qcode{"auto"} or @qcode{"manual"}. ## ## If passed a 2-element vector [@var{y_lo} @var{y_hi}], the limits of the ## y-axis are set to these values and the mode is set to @qcode{"manual"}. @@ -44,8 +44,7 @@ ## ## Programming Note: The @code{ylim} function operates by modifying the ## @qcode{"ylim"} and @qcode{"ylimmode"} properties of an axes object. These -## properties can be be directly inspected and altered with -## @code{get}/@code{set}. +## properties can be directly inspected and altered with @code{get}/@code{set}. ## @seealso{xlim, zlim, axis, set, get, gca} ## @end deftypefn
--- a/scripts/plot/appearance/zlim.m Thu Jun 08 15:56:46 2017 -0700 +++ b/scripts/plot/appearance/zlim.m Thu Jun 08 17:41:32 2017 -0700 @@ -28,11 +28,11 @@ ## Called without arguments @code{zlim} returns the z-axis limits of the ## current plot. ## -## With the input query @qcode{"mode"}, return the current -## z-limit calculation mode which is either @qcode{"auto"} or @qcode{"manual"}. +## With the input query @qcode{"mode"}, return the current z-limit calculation +## mode which is either @qcode{"auto"} or @qcode{"manual"}. ## ## If passed a 2-element vector [@var{z_lo} @var{z_hi}], the limits of the -## x-axis are set to these values and the mode is set to @qcode{"manual"}. +## z-axis are set to these values and the mode is set to @qcode{"manual"}. ## The special values -Inf and Inf can be used to indicate that either ## the lower axis limit or upper axis limit should be automatically calculated. ## @@ -44,8 +44,7 @@ ## ## Programming Note: The @code{zlim} function operates by modifying the ## @qcode{"zlim"} and @qcode{"zlimmode"} properties of an axes object. These -## properties can be be directly inspected and altered with -## @code{get}/@code{set}. +## properties can be directly inspected and altered with @code{get}/@code{set}. ## @seealso{xlim, ylim, axis, set, get, gca} ## @end deftypefn
--- a/scripts/plot/util/hgtransform.m Thu Jun 08 15:56:46 2017 -0700 +++ b/scripts/plot/util/hgtransform.m Thu Jun 08 17:41:32 2017 -0700 @@ -17,9 +17,9 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {@var{h} =} {} hgtransform () -## @deftypefnx {@var{h} =} {} hgtransform (@var{property}, @var{value}, @dots{}) -## @deftypefnx {@var{h} =} {} hgtransform (@var{hax}, @dots{}) +## @deftypefn {} {@var{h} =} hgtransform () +## @deftypefnx {} {@var{h} =} hgtransform (@var{property}, @var{value}, @dots{}) +## @deftypefnx {} {@var{h} =} hgtransform (@var{hax}, @dots{}) ## ## Create a graphics transform object. ##
--- a/scripts/sparse/eigs.m Thu Jun 08 15:56:46 2017 -0700 +++ b/scripts/sparse/eigs.m Thu Jun 08 17:41:32 2017 -0700 @@ -144,7 +144,7 @@ ## @item permB ## The permutation vector of the Cholesky@tie{}factorization of @var{B} if ## @code{cholB} is true. It is obtained by @code{[R, ~, permB] = -## chol (@var{B}, @qcode{"vector"})}. The default is @code{1:@var{n}}. +## chol (@var{B}, @qcode{"vector"})}. The default is @code{1:@var{n}}. ## ## @end table ##
--- a/scripts/strings/native2unicode.m Thu Jun 08 15:56:46 2017 -0700 +++ b/scripts/strings/native2unicode.m Thu Jun 08 17:41:32 2017 -0700 @@ -24,12 +24,12 @@ ## The numbers in the vector @var{native_bytes} are rounded and clipped to ## integers between 0 and 255. This byte stream is then mapped into the ## code page given by the string @var{codepage} and returned in the string -## @var{utf8_str}. Octave uses UTF-8 as its internal encoding. -## The string @var{codepage} must be an identifier of a valid code page. -## Examples for valid code pages are "ISO-8859-1", "Shift-JIS", or "UTF-16". -## For a list of supported code pages, see: -## http://www.gnu.org/software/libiconv/ -## If @var{codepage} is omitted or empty, the system default codepage is used. +## @var{utf8_str}. Octave uses UTF-8 as its internal encoding. The string +## @var{codepage} must be an identifier of a valid code page. Examples for +## valid code pages are @qcode{"ISO-8859-1"}, @qcode{"Shift-JIS"}, or +## @qcode{"UTF-16"}. For a list of supported code pages, see +## @url{http://www.gnu.org/software/libiconv}. If @var{codepage} is omitted +## or empty, the system default codepage is used. ## ## If @var{native_bytes} is a string vector, it is returned as is. ## @@ -55,7 +55,7 @@ error ("native2unicode: CODEPAGE must be a string") endif - ## FIXME: would it be better to do this by converting to uint8? Or to + ## FIXME: Would it be better to do this by converting to uint8? Or to ## let __native2unicode to the clipping? Multiple steps here means ## looping through the data and allocating memory multiple times. @@ -71,6 +71,7 @@ endfunction + ## "ЄЅІЇЈЉЊ" %!assert (double (native2unicode (164:170, 'ISO-8859-5')), %! [208 132 208 133 208 134 208 135 208 136 208 137 208 138]); @@ -82,9 +83,9 @@ %!assert (double (native2unicode ([0 0 120.3 0 0 122.6 0 0])), %! [0 0 120 0 0 123 0 0]); +%!error <Invalid call> native2unicode () +%!error <Invalid call> native2unicode (1, 'ISO-8859-1', 'test') %!error <NATIVE_BYTES must be a numeric vector> native2unicode ([1 2; 3 4]) %!error <NATIVE_BYTES must be a numeric vector> native2unicode ({1 2 3 4}) %!error <CODEPAGE must be a string> native2unicode (164:170, 123) %!error <converting from codepage 'foo' to UTF-8> native2unicode (234, 'foo') -%!error <Invalid call> native2unicode () -%!error <Invalid call> native2unicode (1, 'ISO-8859-1', 'test')
--- a/scripts/strings/unicode2native.m Thu Jun 08 15:56:46 2017 -0700 +++ b/scripts/strings/unicode2native.m Thu Jun 08 17:41:32 2017 -0700 @@ -22,12 +22,12 @@ ## Convert UTF-8 string @var{utf8_str} to byte stream using @var{codepage}. ## ## The character vector @var{utf8_str} is converted to a byte stream -## @var{native_bytes} using the code page given by @var{codepage}. -## The string @var{codepage} must be an identifier of a valid code page. -## Examples for valid code pages are "ISO-8859-1", "Shift-JIS", or "UTF-16". -## For a list of supported code pages, see: -## http://www.gnu.org/software/libiconv/ -## If @var{codepage} is omitted or empty, the system default codepage is used. +## @var{native_bytes} using the code page given by @var{codepage}. The +## string @var{codepage} must be an identifier of a valid code page. +## Examples for valid code pages are @qcode{"ISO-8859-1"}, +## @qcode{"Shift-JIS"}, or @qcode{"UTF-16"}. For a list of supported code +## pages, see @url{http://www.gnu.org/software/libiconv}. If @var{codepage} +## is omitted or empty, the system default codepage is used. ## ## If any of the characters cannot be mapped into the codepage @var{codepage}, ## they are replaced with the appropriate substitution sequence for that @@ -58,12 +58,13 @@ endfunction + %!assert (unicode2native ("ЄЅІЇЈЉЊ", "ISO-8859-5"), uint8 (164:170)); %!assert (unicode2native (["ЄЅІ" 0 "ЇЈЉЊ"], "ISO-8859-5"), uint8 ([164:166 0 167:170])); +%!error <Invalid call> unicode2native () +%!error <Invalid call> unicode2native ('a', 'ISO-8859-1', 'test') %!error <UTF8_STR must be a character vector> unicode2native (['ab'; 'cd']) %!error <UTF8_STR must be a character vector> unicode2native ({1 2 3 4}) %!error <CODEPAGE must be a string> unicode2native ('ЄЅІЇЈЉЊ', 123) %!error <converting from UTF-8 to codepage 'foo'> unicode2native ('a', 'foo') -%!error <Invalid call> unicode2native () -%!error <Invalid call> unicode2native ('a', 'ISO-8859-1', 'test')