changeset 33196:3e0b916d4666

maint: Merge stable to default.
author Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
date Tue, 12 Mar 2024 15:02:31 -0400
parents 16aa98e2c3e7 (current diff) 773c6bd19630 (diff)
children bee755660415
files scripts/plot/draw/patch.m
diffstat 1 files changed, 19 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/plot/draw/patch.m	Mon Mar 11 17:44:36 2024 +0100
+++ b/scripts/plot/draw/patch.m	Tue Mar 12 15:02:31 2024 -0400
@@ -71,10 +71,25 @@
 ## The optional return value @var{h} is a graphics handle to the created patch
 ## object.
 ##
-## Programming Note: The full list of properties is documented at
-## @ref{Patch Properties}.  Useful patch properties include:
-## @qcode{"cdata"}, @qcode{"edgecolor"}, @qcode{"facecolor"}, @qcode{"faces"},
-## and @qcode{"facevertexcdata"}.
+## Programming Notes:
+## @enumerate
+## @item
+## The full list of properties is documented at @ref{Patch Properties}.
+## Useful patch properties include: @qcode{"cdata"}, @qcode{"edgecolor"},
+## @qcode{"facecolor"}, @qcode{"faces"}, @qcode{"vertices"}, and
+## @qcode{"facevertexcdata"}.
+## @item
+## Properties specifying patch geometry (@qcode{"xdata"}, @qcode{"ydata"},
+## @qcode{"zdata"}, @qcode{"faces"}, @qcode{"vertices"}) should be specified
+## before other properties to avoid unexpected plot outputs or errors.
+## @item
+## Unexpected geometry results can occur from mixing x-y-z and
+## face-vertex forms of defining geometry.
+## @item
+## Unexpected patch color results can occur from using @qcode{"cdata"} color
+## definitons with face-vertex defined geometry or @qcode{"facecentercdata"}
+## color definitions with x-y-z defined geometry.
+## @end enumerate
 ## @seealso{fill, get, set}
 ## @end deftypefn