changeset 24320:174a4426d441 stable

stairs.m: Add example @code section showing what "indices of elements" means. * stairs.m: Add example @code section showing what "indices of elements" means.
author Rik <rik@octave.org>
date Mon, 27 Nov 2017 16:58:25 -0800
parents 3cdd2b6c78cb
children c381bca75c64 740c6a7db92a
files scripts/plot/draw/stairs.m
diffstat 1 files changed, 2 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/plot/draw/stairs.m	Mon Nov 27 16:51:14 2017 -0800
+++ b/scripts/plot/draw/stairs.m	Mon Nov 27 16:58:25 2017 -0800
@@ -28,7 +28,8 @@
 ##
 ## The arguments @var{x} and @var{y} may be vectors or matrices.
 ## If only one argument is given, it is taken as a vector of Y values
-## and the X coordinates are taken to be the indices of the elements.
+## and the X coordinates are taken to be the indices of the elements
+## (@code{@var{x} = 1:numel (@var{y})}).
 ##
 ## The style to use for the plot can be defined with a line style @var{style}
 ## of the same format as the @code{plot} command.