Mercurial > octave
changeset 33216:1ba981407122 stable
doc: describe shape of outputs for hist (bug #65471)
* scripts/plot/draw/hist.m: Expand docstring description of output shapes of
xx and nn for vector and array y inputs.
| author | Nicholas R. Jankowski <jankowski.nicholas@gmail.com> |
|---|---|
| date | Sun, 17 Mar 2024 22:44:25 -0400 |
| parents | c59ff2782e04 |
| children | fd4b199bfe3e 32002886fc7c |
| files | scripts/plot/draw/hist.m |
| diffstat | 1 files changed, 4 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/plot/draw/hist.m Tue Mar 12 15:53:42 2024 -0400 +++ b/scripts/plot/draw/hist.m Sun Mar 17 22:44:25 2024 -0400 @@ -82,7 +82,10 @@ ## ## If an output is requested then no plot is made. Instead, return the values ## @var{nn} (numbers of elements) and @var{xx} (bin centers) such that -## @code{bar (@var{xx}, @var{nn})} will plot the histogram. +## @code{bar (@var{xx}, @var{nn})} will plot the histogram. If @var{y} is a +## vector, @var{nn} and @var{xx} will be row vectors. If @var{y} is an array, +## @var{nn} will be an array with one column of element counts for each column +## in @var{y}, and @var{xx} will be a column vector of bin centers. ## ## @seealso{histc, bar, pie, rose} ## @end deftypefn