Mercurial > hg > octave-lyh

changeset 17085:d3ebc3f9bdbf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc update for grid and subplot
author Michael Godfrey <michaeldgodfrey@gmail.com>
date Thu, 25 Jul 2013 18:18:32 -0400
parents 872947f3f9f1
children 3db796f89695
files scripts/plot/grid.m scripts/plot/subplot.m
diffstat 2 files changed, 5 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/plot/grid.m
+++ b/scripts/plot/grid.m
@@ -71,7 +71,7 @@
   else
     x = varargin{1};
     if (! ischar (x))
-      error ("grid: argument must be a string");
+      error ("grid: argument 1 must be an axis handle or a string");
     endif
     if (strcmpi (x, "off"))
       grid_on = false;
--- a/scripts/plot/subplot.m
+++ b/scripts/plot/subplot.m
@@ -19,9 +19,13 @@
 ## -*- texinfo -*-
 ## @deftypefn  {Function File} {} subplot (@var{rows}, @var{cols}, @var{index})
 ## @deftypefnx {Function File} {} subplot (@var{rcn})
+## @deftypefnx {Function File} {@var{ax}} = subplot (@var{rcn}, ...)
 ## Set up a plot grid with @var{rows} by @var{cols} subwindows and plot
 ## in location given by @var{index}.
 ##
+## If @var{ax} is provided, subplot returns the axis handle for the subplot.
+## This is usuful for modifying the properties of a subplot.
+##
 ## If only one argument is supplied, then it must be a three digit value
 ## specifying the location in digits 1 (rows) and 2 (columns) and the plot
 ## index in digit 3.