changeset 24319:3cdd2b6c78cb stable

doc: Correct surface plot explanation of meshgridded results of 1 input (bug #52536) * contourc.m, meshz.m, surface.m, surfnorm.m: Correctly explain that X is determined from the columns of Z and Y is determined from the rows of Z for a single input argument Z.
author Rik <rik@octave.org>
date Mon, 27 Nov 2017 16:51:14 -0800
parents 678912855789
children 174a4426d441
files scripts/plot/draw/contourc.m scripts/plot/draw/meshz.m scripts/plot/draw/surface.m scripts/plot/draw/surfnorm.m
diffstat 4 files changed, 7 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/plot/draw/contourc.m	Sat Nov 25 20:52:46 2017 +0100
+++ b/scripts/plot/draw/contourc.m	Mon Nov 27 16:51:14 2017 -0800
@@ -25,8 +25,8 @@
 ##
 ## The matrix @var{z} contains height values above the rectangular grid
 ## determined by @var{x} and @var{y}.  If only a single input @var{z} is
-## provided then @var{x} is taken to be @code{1:rows (@var{z})} and @var{y} is
-## taken to be @code{1:columns (@var{z})}.
+## provided then @var{x} is taken to be @code{1:columns (@var{z})} and @var{y}
+## is taken to be @code{1:rows (@var{z})}.
 ##
 ## The optional input @var{vn} is either a scalar denoting the number of
 ## contour lines to compute or a vector containing the Z values where lines
--- a/scripts/plot/draw/meshz.m	Sat Nov 25 20:52:46 2017 +0100
+++ b/scripts/plot/draw/meshz.m	Mon Nov 27 16:51:14 2017 -0800
@@ -30,7 +30,7 @@
 ## over a 2-D rectangular region in the x-y plane.  @var{z} determines the
 ## height above the plane of each vertex.  If only a single @var{z} matrix is
 ## given, then it is plotted over the meshgrid
-## @code{@var{x} = 0:columns (@var{z}) - 1, @var{y} = 0:rows (@var{z}) - 1}.
+## @code{@var{x} = 0:(columns (@var{z}) - 1), @var{y} = 0:(rows (@var{z}) - 1}).
 ## Thus, columns of @var{z} correspond to different @var{x} values and rows
 ## of @var{z} correspond to different @var{y} values.
 ##
--- a/scripts/plot/draw/surface.m	Sat Nov 25 20:52:46 2017 +0100
+++ b/scripts/plot/draw/surface.m	Mon Nov 27 16:51:14 2017 -0800
@@ -32,8 +32,8 @@
 ## (@var{x}(j), @var{y}(i), @var{z}(i,j)).  Thus, columns of @var{z} correspond
 ## to different @var{x} values and rows of @var{z} correspond to different
 ## @var{y} values.  If only a single input @var{z} is given then @var{x} is
-## taken to be @code{1:rows (@var{z})} and @var{y} is
-## @code{1:columns (@var{z})}.
+## taken to be @code{1:columns (@var{z})} and @var{y} is
+## @code{1:rows (@var{z})}.
 ##
 ## Any property/value input pairs are assigned to the surface object.
 ##
--- a/scripts/plot/draw/surfnorm.m	Sat Nov 25 20:52:46 2017 +0100
+++ b/scripts/plot/draw/surfnorm.m	Mon Nov 27 16:51:14 2017 -0800
@@ -28,8 +28,8 @@
 ## (@var{x}(j), @var{y}(i), @var{z}(i,j)).  Thus, columns of @var{z} correspond
 ## to different @var{x} values and rows of @var{z} correspond to different
 ## @var{y} values.  If only a single input @var{z} is given then @var{x} is
-## taken to be @code{1:rows (@var{z})} and @var{y} is
-## @code{1:columns (@var{z})}.
+## taken to be @code{1:columns (@var{z})} and @var{y} is
+## @code{1:rows (@var{z})}.
 ##
 ## If no return arguments are requested, a surface plot with the normal
 ## vectors to the surface is plotted.