changeset 28177:bc829338e353 stable

doc: Clarify behavior of "subplot". * subplot.m: The "position" property-value pair cannot be combined with the "rows, cols, index" triplet. (Partly) covered axes are deleted.
author Markus Mützel <markus.muetzel@gmx.de>
date Fri, 27 Mar 2020 15:25:50 +0100
parents b895daca20e2
children 0689e92f8b54
files scripts/plot/util/subplot.m
diffstat 1 files changed, 4 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/plot/util/subplot.m	Fri Mar 27 08:52:33 2020 +0100
+++ b/scripts/plot/util/subplot.m	Fri Mar 27 15:25:50 2020 +0100
@@ -30,7 +30,7 @@
 ## @deftypefnx {} {} subplot (@var{hax})
 ## @deftypefnx {} {} subplot (@dots{}, "align")
 ## @deftypefnx {} {} subplot (@dots{}, "replace")
-## @deftypefnx {} {} subplot (@dots{}, "position", @var{pos})
+## @deftypefnx {} {} subplot ("position", @var{pos})
 ## @deftypefnx {} {} subplot (@dots{}, @var{prop}, @var{val}, @dots{})
 ## @deftypefnx {} {@var{hax} =} subplot (@dots{})
 ## Set up a plot grid with @var{rows} by @var{cols} subwindows and set the
@@ -95,6 +95,9 @@
 ##
 ## Any property/value pairs are passed directly to the underlying axes object.
 ##
+## Any previously existing axes that would be (partly) covered by the newly
+## created axes are deleted.
+##
 ## If the output @var{hax} is requested, subplot returns the axes handle for
 ## the subplot.  This is useful for modifying the properties of a subplot
 ## using @code{set}.