comparison libinterp/corefcn/pr-output.cc @ 30588:ed17822e7662

doc: Always have a return value for functions which set internal variables (bug #61681) * call-stack.cc, dirfns.cc, environment.cc, error.cc, help.cc, input.cc, load-save.cc, ls-oct-text.cc, oct-hist.cc, pager.cc, pr-flt-fmt.cc, pr-output.cc, sighandlers.cc, svd.cc, variables.cc, ov-base.cc, ov-java.cc, ov-struct.cc, ov-usr-fcn.cc, ov.cc, pt-eval.cc, disable_diagonal_matrix.m, disable_permutation_matrix.m, disable_range.m: Always have a return value for functions which set internal variables.
author Rik <rik@octave.org>
date Sat, 01 Jan 2022 19:43:52 -0800
parents d4e559fcf88f
children 08b08b7f05b2
comparison
equal deleted inserted replaced
30587:5d379d2ad903 30588:ed17822e7662
4058 4058
4059 DEFUN (fixed_point_format, args, nargout, 4059 DEFUN (fixed_point_format, args, nargout,
4060 doc: /* -*- texinfo -*- 4060 doc: /* -*- texinfo -*-
4061 @deftypefn {} {@var{val} =} fixed_point_format () 4061 @deftypefn {} {@var{val} =} fixed_point_format ()
4062 @deftypefnx {} {@var{old_val} =} fixed_point_format (@var{new_val}) 4062 @deftypefnx {} {@var{old_val} =} fixed_point_format (@var{new_val})
4063 @deftypefnx {} {} fixed_point_format (@var{new_val}, "local") 4063 @deftypefnx {} {@var{old_val} =} fixed_point_format (@var{new_val}, "local")
4064 Query or set the internal variable that controls whether Octave will 4064 Query or set the internal variable that controls whether Octave will
4065 use a scaled format to print matrix values. 4065 use a scaled format to print matrix values.
4066 4066
4067 The scaled format prints a scaling factor on the first line of output chosen 4067 The scaled format prints a scaling factor on the first line of output chosen
4068 such that the largest matrix element can be written with a single leading 4068 such that the largest matrix element can be written with a single leading
4101 4101
4102 DEFUN (print_empty_dimensions, args, nargout, 4102 DEFUN (print_empty_dimensions, args, nargout,
4103 doc: /* -*- texinfo -*- 4103 doc: /* -*- texinfo -*-
4104 @deftypefn {} {@var{val} =} print_empty_dimensions () 4104 @deftypefn {} {@var{val} =} print_empty_dimensions ()
4105 @deftypefnx {} {@var{old_val} =} print_empty_dimensions (@var{new_val}) 4105 @deftypefnx {} {@var{old_val} =} print_empty_dimensions (@var{new_val})
4106 @deftypefnx {} {} print_empty_dimensions (@var{new_val}, "local") 4106 @deftypefnx {} {@var{old_val} =} print_empty_dimensions (@var{new_val}, "local")
4107 Query or set the internal variable that controls whether the dimensions of 4107 Query or set the internal variable that controls whether the dimensions of
4108 empty matrices are printed along with the empty matrix symbol, @samp{[]}. 4108 empty matrices are printed along with the empty matrix symbol, @samp{[]}.
4109 4109
4110 For example, the expression 4110 For example, the expression
4111 4111
4132 4132
4133 DEFUN (split_long_rows, args, nargout, 4133 DEFUN (split_long_rows, args, nargout,
4134 doc: /* -*- texinfo -*- 4134 doc: /* -*- texinfo -*-
4135 @deftypefn {} {@var{val} =} split_long_rows () 4135 @deftypefn {} {@var{val} =} split_long_rows ()
4136 @deftypefnx {} {@var{old_val} =} split_long_rows (@var{new_val}) 4136 @deftypefnx {} {@var{old_val} =} split_long_rows (@var{new_val})
4137 @deftypefnx {} {} split_long_rows (@var{new_val}, "local") 4137 @deftypefnx {} {@var{old_val} =} split_long_rows (@var{new_val}, "local")
4138 Query or set the internal variable that controls whether rows of a matrix 4138 Query or set the internal variable that controls whether rows of a matrix
4139 may be split when displayed to a terminal window. 4139 may be split when displayed to a terminal window.
4140 4140
4141 If the rows are split, Octave will display the matrix in a series of smaller 4141 If the rows are split, Octave will display the matrix in a series of smaller
4142 pieces, each of which can fit within the limits of your terminal width and 4142 pieces, each of which can fit within the limits of your terminal width and