Skip to content

Commit

Permalink
maint: merge stable to default
Browse files Browse the repository at this point in the history
  • Loading branch information
Rik committed Nov 23, 2024
2 parents 1caf9e6 + 9ac06ca commit fb71bbf
Show file tree
Hide file tree
Showing 25 changed files with 89 additions and 82 deletions.
8 changes: 4 additions & 4 deletions doc/interpreter/basics.txi
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,8 @@ Print short help message and exit.
Add path to the head of the search path for images. The value of
@var{path} specified on the command line will override any value of
@w{@env{OCTAVE_IMAGE_PATH}}@ found in the environment, but not any commands
in the system or user startup files that call the @w{@env{IMAGE_PATH}}@
function.
in the system or user startup files that call the
@w{@env{IMAGE_PATH}}@ function.

@item --info-file @var{filename}
@cindex @sortas{options, Octave command --info-file} @ @ @code{--info-file @var{filename}}
Expand Down Expand Up @@ -361,8 +361,8 @@ overridden by the environment variable @w{@env{OCTAVE_VERSION_INITFILE}}.
@item @var{config-dir}/octave/octaverc
@cindex personal startup file
where @code{@var{config-dir}} is the platform-dependent location for user
local configuration files (e.g., @w{@env{$XDG_CONFIG_HOME}} on many Unix-like
operating systems or @w{@env{%APPDATA%}} on Windows).
local configuration files (e.g., @w{@env{$XDG_CONFIG_HOME}}@ on many Unix-like
operating systems or @w{@env{%APPDATA%}}@ on Windows).

@item ~/.octaverc
@cindex personal startup file
Expand Down
4 changes: 2 additions & 2 deletions doc/interpreter/expr.txi
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ data(idx)

@noindent
Instead of creating the @code{idx} array it is possible to replace
@code{data(idx)} with @w{@code{data( data <= 2 )}} in the above code.
@code{data(idx)} with @w{@code{data( data <= 2 )}}@ in the above code.

While the size of the logical index expressions is usually the same as that
of the array being indexed, this is not a necessary condition. If the logical
Expand Down Expand Up @@ -375,7 +375,7 @@ the respective dimension of the array.
However, if the number of indexing components exceeds the number of dimensions
(@w{@code{M > nd}}) then the excess components must all be singletons
(@code{1}). Moreover, if @w{@code{M < nd}}, the behavior is equivalent to
reshaping the input object so as to merge the trailing @w{@code{nd - M}}
reshaping the input object so as to merge the trailing @w{@code{nd - M}}@
dimensions into the last index dimension @code{M}. Thus, the result will have
the dimensionality of the index expression, and not the original object. This
is the case whenever dimensionality of the index is greater than one
Expand Down
5 changes: 3 additions & 2 deletions doc/interpreter/external.txi
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,9 @@ most of the definitions necessary for a C++ oct-file. Note that
@file{octave/oct.h} is a C++ header and cannot be directly @code{#include}'ed
in a C source file, nor any other language.

Included by @file{oct.h} is a definition for the macro @w{@code{DEFUN_DLD}}@
which creates a dynamically loaded function. This macro takes four arguments:
Included by @file{oct.h} is a definition for the macro
@w{@code{DEFUN_DLD}}@ which creates a dynamically loaded function. This macro
takes four arguments:

@enumerate 1
@item The function name as it will be seen in Octave,
Expand Down
48 changes: 24 additions & 24 deletions doc/interpreter/genpropdoc.m
Original file line number Diff line number Diff line change
Expand Up @@ -580,7 +580,7 @@ position and size of the figure (in @code{paperunits} units) on the printed \
figure on the page, and the size is defined by @code{[width height]}. For \
output formats not implicitly rendered on paper, @code{width} and \
@code{height} define the size of the image and the position information is \
ignored. __modemsg__.";
ignored. __modemsg__";
s.valid = valid_4elvec;
s.category = "Printing/Saving";

Expand Down Expand Up @@ -649,7 +649,7 @@ element defines a pixel with the element (1,1) representing the \

case "renderer"
s.doc = "Rendering engine used for printing when @code{renderermode} \
is @qcode{\"manual\"}. __modemsg__.";
is @qcode{\"manual\"}. __modemsg__";
s.category = "Printing/Saving";

case "renderermode"
Expand Down Expand Up @@ -823,7 +823,7 @@ element defines a pixel with the element (1,1) representing the \

case "cameraposition"
s.doc = "Coordinates of the camera position viewing the \
__objname__. __modemsg__.";
__objname__. __modemsg__";
s.valid = valid_3elvec;
s.category = "Camera and View Controls";

Expand All @@ -836,7 +836,7 @@ element defines a pixel with the element (1,1) representing the \

case "cameratarget"
s.doc = "Coordinates of the point at which the viewing camera is \
aimed. __modemsg__.";
aimed. __modemsg__";
s.valid = valid_3elvec;
s.category = "Camera and View Controls";

Expand All @@ -850,7 +850,7 @@ element defines a pixel with the element (1,1) representing the \
case "cameraupvector"
s.doc = "A 3-element vector defining the upward direction of the \
current view. Note that the default is [0 1 0] for 2-D plots and [0 0 1] for \
3-D plots. __modemsg__.";
3-D plots. __modemsg__";
s.valid = valid_3elvec;
s.category = "Camera and View Controls";

Expand All @@ -863,7 +863,7 @@ element defines a pixel with the element (1,1) representing the \

case "cameraviewangle"
s.doc = "The camera's field of view defined as an angle between 0 \
and 180 degrees. __modemsg__.";
and 180 degrees. __modemsg__";
s.valid = "scalar";
s.category = "Camera and View Controls";

Expand All @@ -877,7 +877,7 @@ element defines a pixel with the element (1,1) representing the \
case "clim"
s.doc = "Define limits for the color axis of __objname__ \
children that have the @qcode{cdata} property. \
__modemsg__.";
__modemsg__";
s.valid = valid_2elvec;
s.category = "Color and Transparency";

Expand Down Expand Up @@ -942,7 +942,7 @@ element defines a pixel with the element (1,1) representing the \
displayed in the axes. Setting @code{dataaspectratio} to \
@w{@code{[1, 2]}} causes the length of one unit as displayed on the x-axis \
to be the same as the length of 2 units on the y-axis. \
@xref{XREFdaspect, , daspect function}. __modemsg__.";
@xref{XREFdaspect, , daspect function}. __modemsg__";
s.valid = valid_3elvec;
s.category = "Axes Box Appearance";

Expand All @@ -964,7 +964,7 @@ element defines a pixel with the element (1,1) representing the \
s.category = "Text Appearance";

case "fontsize"
s.doc = [doc_fontsize, " __modemsg__."];
s.doc = [doc_fontsize, " __modemsg__"];
s.valid = "scalar";
s.category = "Text Appearance";

Expand Down Expand Up @@ -997,7 +997,7 @@ element defines a pixel with the element (1,1) representing the \

case "gridcolor"
s.doc = "Color of the major grid lines. \
@xref{Colors, , colorspec}. __modemsg__.";
@xref{Colors, , colorspec}. __modemsg__";
s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"});
s.category = "Axes Grid Appearance";

Expand Down Expand Up @@ -1070,7 +1070,7 @@ element defines a pixel with the element (1,1) representing the \

case "minorgridcolor"
s.doc = "Color of the minor grid lines. \
@xref{Colors, , colorspec}. __modemsg__.";
@xref{Colors, , colorspec}. __modemsg__";
s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"});
s.category = "Axes Grid Appearance";

Expand Down Expand Up @@ -1119,7 +1119,7 @@ element defines a pixel with the element (1,1) representing the \
s.category = "Object Position";

case "plotboxaspectratio"
s.doc = "@xref{XREFpbaspect, , pbaspect function}. __modemsg__.";
s.doc = "@xref{XREFpbaspect, , pbaspect function}. __modemsg__";
s.category = "Object Position";

case "plotboxaspectratiomode"
Expand Down Expand Up @@ -1172,7 +1172,7 @@ element defines a pixel with the element (1,1) representing the \
s.doc = "Control whether axes tick marks project @qcode{\"in\"} to \
the plot box or @qcode{\"out\"}. The value @qcode{\"both\"} will draw tick \
marks both in and out. The value @qcode{\"none\"} means no tick marks will \
be drawn, although tick labels will still be rendered. __modemsg__. Note \
be drawn, although tick labels will still be rendered. __modemsg__ Note \
that the default is @qcode{\"in\"} for 2-D and @qcode{\"out\"} for 3-D \
plots.";
s.category = "Axes Box Appearance";
Expand Down Expand Up @@ -1246,7 +1246,7 @@ element defines a pixel with the element (1,1) representing the \

case "xcolor"
s.doc = "Color of the x-axis. @xref{Colors, , colorspec}. \
__modemsg__.";
__modemsg__";
s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"});
s.category = "Axes Box Appearance";

Expand Down Expand Up @@ -1276,7 +1276,7 @@ element defines a pixel with the element (1,1) representing the \

case "xlim"
s.doc = "Two-element vector @code{[xmin xmax]} specifying the limits \
for the x-axis. __modemsg__. @xref{XREFxlim, , @w{xlim function}}.";
for the x-axis. __modemsg__ @xref{XREFxlim, , @w{xlim function}}.";
s.valid = valid_2elvec;
s.category = "Axes Box Appearance";

Expand Down Expand Up @@ -1310,13 +1310,13 @@ element defines a pixel with the element (1,1) representing the \
s.category = "Axes Grid Appearance";

case "xtick"
s.doc = "Position of x tick marks. __modemsg__.";
s.doc = "Position of x tick marks. __modemsg__";
s.valid = "vector";
s.printdefault = false;
s.category = "Axes Box Appearance";

case "xticklabel"
s.doc = "Labels of x tick marks. __modemsg__.";
s.doc = "Labels of x tick marks. __modemsg__";
s.valid = valid_cellstring;
s.category = "Text Appearance";

Expand Down Expand Up @@ -1375,7 +1375,7 @@ element defines a pixel with the element (1,1) representing the \

case "ylim"
s.doc = "Two-element vector @code{[ymin ymax]} specifying the limits \
for the y-axis. __modemsg__. @xref{XREFylim, , @w{ylim function}}.";
for the y-axis. __modemsg__ @xref{XREFylim, , @w{ylim function}}.";
s.valid = valid_2elvec;
s.category = "Axes Box Appearance";

Expand Down Expand Up @@ -1409,13 +1409,13 @@ element defines a pixel with the element (1,1) representing the \
s.category = "Axes Grid Appearance";

case "ytick"
s.doc = "Position of y tick marks. __modemsg__.";
s.doc = "Position of y tick marks. __modemsg__";
s.valid = "vector";
s.printdefault = false;
s.category = "Axes Box Appearance";

case "yticklabel"
s.doc = "Labels of y tick marks. __modemsg__.";
s.doc = "Labels of y tick marks. __modemsg__";
s.valid = valid_cellstring;
s.category = "Text Appearance";

Expand Down Expand Up @@ -1470,7 +1470,7 @@ element defines a pixel with the element (1,1) representing the \

case "zlim"
s.doc = "Two-element vector @code{[zmin zmax]} specifying the limits \
for the z-axis. __modemsg__. @xref{XREFzlim, , @w{zlim function}}.";
for the z-axis. __modemsg__ @xref{XREFzlim, , @w{zlim function}}.";
s.valid = valid_2elvec;
s.category = "Axes Box Appearance";

Expand Down Expand Up @@ -1504,13 +1504,13 @@ element defines a pixel with the element (1,1) representing the \
s.category = "Axes Grid Appearance";

case "ztick"
s.doc = "Position of z tick marks. __modemsg__.";
s.doc = "Position of z tick marks. __modemsg__";
s.valid = "vector";
s.printdefault = false;
s.category = "Axes Box Appearance";

case "zticklabel"
s.doc = "Labels of z tick marks. __modemsg__.";
s.doc = "Labels of z tick marks. __modemsg__";
s.valid = valid_cellstring;
s.category = "Text Appearance";

Expand Down Expand Up @@ -1596,7 +1596,7 @@ automatically when objects are added to (or deleted from) the peer axes.\n\
legend (\"numcolumns\", 3);\n\
@end group\n\
@end example\n\
__modemsg__.";
__modemsg__";
s.valid = "scalar integer";
s.category = "Layout";

Expand Down
2 changes: 1 addition & 1 deletion doc/interpreter/install.txi
Original file line number Diff line number Diff line change
Expand Up @@ -839,7 +839,7 @@ Octave's 64-bit index support is activated with the configure option
You must ensure that all Fortran sources except those in the
@file{liboctave/external/ranlib} directory are compiled such that INTEGERS are
8-bytes wide. If you are using gfortran, the configure script should
automatically set the Makefile variable @w{@env{F77_INTEGER_8_FLAG}} to
automatically set the Makefile variable @w{@env{F77_INTEGER_8_FLAG}}@ to
@option{-fdefault-integer-8}. If you are using another compiler, you
must set this variable yourself. You should NOT set this flag in
@env{FFLAGS}, otherwise the files in @file{liboctave/external/ranlib} will be
Expand Down
4 changes: 2 additions & 2 deletions doc/interpreter/oop.txi
Original file line number Diff line number Diff line change
Expand Up @@ -771,8 +771,8 @@ f.polynomial = 1 + 2 * X + 3 * X ^ 2
@end group
@end example

Defining the @w{FIRfilter} class as a child of the polynomial class implies
that a @w{FIRfilter} object may be used any place that a polynomial object may
Defining the @w{FIRfilter}@ class as a child of the polynomial class implies
that a @w{FIRfilter}@ object may be used any place that a polynomial object may
be used. This is not a normal use of a filter. It may be a more sensible
design approach to use aggregation rather than inheritance. In this case, the
polynomial is simply a field in the class structure. A class constructor for
Expand Down
8 changes: 4 additions & 4 deletions doc/interpreter/package.txi
Original file line number Diff line number Diff line change
Expand Up @@ -245,8 +245,8 @@ autoload ('bar', which ('foo'));
@end example

@noindent
@xref{PKG_ADD and PKG_DEL Directives}, for details on @w{@code{PKG_ADD}}@
directives.
@xref{PKG_ADD and PKG_DEL Directives}, for details on
@w{@code{PKG_ADD}}@ directives.

@cindex PKG_DEL
@anchor{XREFPKG_DEL}
Expand All @@ -255,8 +255,8 @@ An optional file that includes commands that are run when the package
is removed from the users path. Note that @w{@code{PKG_DEL}}@ directives in
the source code of the package will also be added to this file by the
Octave package manager.
@xref{PKG_ADD and PKG_DEL Directives}, for details on @w{@code{PKG_DEL}}@
directives.
@xref{PKG_ADD and PKG_DEL Directives}, for details on
@w{@code{PKG_DEL}}@ directives.

@item package/pre_install.m
This is an optional function that is run prior to the installation of a
Expand Down
12 changes: 6 additions & 6 deletions doc/interpreter/plot.txi
Original file line number Diff line number Diff line change
Expand Up @@ -817,8 +817,8 @@ numerically @tab

Finally, superscripting and subscripting can be controlled with the @qcode{'^'}
and @qcode{'_'} characters. If the @qcode{'^'} or @qcode{'_'} is followed by a
@{ character, then all of the block surrounded by the @w{@{ @}} pair is
superscripted or subscripted. Without the @w{@{ @}} pair, only the character
@{ character, then all of the block surrounded by the @w{@{ @}}@ pair is
superscripted or subscripted. Without the @w{@{ @}}@ pair, only the character
immediately following the @qcode{'^'} or @qcode{'_'} is changed.

@float Table,tab:extended
Expand Down Expand Up @@ -1065,10 +1065,10 @@ width 0.6pt \tabskip=0pt\cr
@cindex Degree Symbol

Conformance to both @TeX{} and @sc{matlab} with respect to the @code{\circ}
symbol is impossible. While @TeX{} translates this symbol to @w{Unicode 2218}
(U+2218), @sc{matlab} maps this to @w{Unicode 00B0} (U+00B0) instead. Octave
has chosen to follow the @TeX{} specification, but has added the additional
symbol @code{\deg} which maps to the degree symbol (U+00B0).
symbol is impossible. While @TeX{} translates this symbol to
@w{Unicode 2218}@ (U+2218), @sc{matlab} maps this to @w{Unicode 00B0}@ (U+00B0)
instead. Octave has chosen to follow the @TeX{} specification, but has added
the additional symbol @code{\deg} which maps to the degree symbol (U+00B0).

@node "latex" interpreter
@subsubsection "latex" interpreter
Expand Down
4 changes: 2 additions & 2 deletions libinterp/corefcn/bitfcns.cc
Original file line number Diff line number Diff line change
Expand Up @@ -669,8 +669,8 @@ The input is either a string specifying a floating point type, or it is an
existing floating point variable @var{var}.
The default type is @qcode{"double"}, but @qcode{"single"} is a valid option.
On IEEE 754 compatible systems, @code{flintmax} is @w{@math{2^{53}}} for
@qcode{"double"} and @w{@math{2^{24}}} for @qcode{"single"}.
On IEEE 754 compatible systems, @code{flintmax} is @w{@math{2^{53}}}@ for
@qcode{"double"} and @w{@math{2^{24}}}@ for @qcode{"single"}.
Example Code - query an existing variable
Expand Down
6 changes: 3 additions & 3 deletions libinterp/corefcn/chol.cc
Original file line number Diff line number Diff line change
Expand Up @@ -807,8 +807,8 @@ original factored matrix.
Given a Cholesky@tie{}factorization of a real symmetric or complex Hermitian
positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper
triangular, return the Cholesky@tie{}factorization of
@var{A1}, where @w{A1(p,p) = A}, @w{A1(:,j) = A1(j,:)' = u} and
@w{p = [1:j-1,j+1:n+1]}. @w{u(j)} should be positive.
@var{A1}, where @w{A1(p,p) = A}, @w{A1(:,j) = A1(j,:)' = u}@ and
@w{p = [1:j-1,j+1:n+1]}. @w{u(j)}@ should be positive.
On return, @var{info} is set to
Expand Down Expand Up @@ -1186,7 +1186,7 @@ original factored matrix.
Given a Cholesky@tie{}factorization of a real symmetric or complex Hermitian
positive definite matrix @w{@var{A} = @var{R}'*@var{R}}, @var{R}@tie{}upper
triangular, return the Cholesky@tie{}factorization of
@w{@var{A}(p,p)}, where @w{p} is the permutation @*
@w{@var{A}(p,p)}, where p is the permutation @*
@code{p = [1:i-1, circshift(i:j, 1), j+1:n]} if @w{@var{i} < @var{j}} @*
or @*
@code{p = [1:j-1, circshift(j:i,-1), i+1:n]} if @w{@var{j} < @var{i}}. @*
Expand Down
6 changes: 3 additions & 3 deletions libinterp/corefcn/environment.cc
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,9 @@ DEFMETHOD (EDITOR, interp, args, nargout,
@deftypefnx {} {@var{old_val} =} EDITOR (@var{new_val}, "local")
Query or set the internal variable that specifies the default text editor.
The default value is taken from the environment variable @w{@env{EDITOR}}@
when Octave starts. If the environment variable is not initialized,
@w{@env{EDITOR}}@ will be set to @qcode{"emacs"}.
The default value is taken from the environment variable
@w{@env{EDITOR}}@ when Octave starts. If the environment variable is not
initialized, @w{@env{EDITOR}}@ will be set to @qcode{"emacs"}.
When called from inside a function with the @qcode{"local"} option, the
variable is changed locally for the function and any subroutines it calls.
Expand Down
9 changes: 5 additions & 4 deletions libinterp/corefcn/oct-hist.cc
Original file line number Diff line number Diff line change
Expand Up @@ -825,10 +825,11 @@ All future commands issued during the current Octave session will be written to
this new file (if the current setting of @code{history_save} allows for this).
The default value is @file{@w{@env{$DATA}}/octave/history}, where
@w{@env{$DATA}} is the platform-specific location for (roaming) user data files
(e.g., @w{@env{$XDG_DATA_HOME}} or, if that is not set, @file{~/.local/share}
on Unix-like operating systems or @w{@env{%APPDATA%}} on Windows). The default
value may be overridden by the environment variable @w{@env{OCTAVE_HISTFILE}}.
@w{@env{$DATA}}@ is the platform-specific location for (roaming) user data files
(e.g., @w{@env{$XDG_DATA_HOME}}@ or, if that is not set, @file{~/.local/share}
on Unix-like operating systems or @w{@env{%APPDATA%}}@ on Windows). The
default value may be overridden by the environment variable
@w{@env{OCTAVE_HISTFILE}}.
Programming Notes:
Expand Down
Loading

0 comments on commit fb71bbf

Please sign in to comment.