changeset 7978:f8514786c490

Clarify help of the shading function
author David Bateman <dbateman@free.fr>
date Sun, 27 Jul 2008 22:38:08 +0200
parents 065c28e1c368
children ff6c1534b522
files scripts/ChangeLog scripts/plot/shading.m
diffstat 2 files changed, 18 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/ChangeLog	Mon Jul 28 10:50:46 2008 +0200
+++ b/scripts/ChangeLog	Sun Jul 27 22:38:08 2008 +0200
@@ -1,5 +1,7 @@
 2008-07-28  David Bateman  <dbateman@free.fr>
 
+	* plot/shading.m: Clarify help string.
+	
 	* general/genvarname.m: Trivial documentation fix.
 
 2008-07-28  John W. Eaton  <jwe@octave.org>
--- a/scripts/plot/shading.m	Mon Jul 28 10:50:46 2008 +0200
+++ b/scripts/plot/shading.m	Sun Jul 27 22:38:08 2008 +0200
@@ -20,9 +20,22 @@
 ## @deftypefn {Function File} {} shading (@var{type})
 ## @deftypefnx {Function File} {} shading (@var{ax}, @dots{})
 ## Set the shading of surface or patch graphic objects. Valid arguments
-## for @var{type} are @code{"flat"}, @code{"interp"}, or
-## @code{"faceted"}.  If @var{ax} is given the shading is applied to
-## axis @var{ax} instead of the current axis.
+## for @var{type} are
+##
+## @table @code
+## @item "flat"
+## Single colored patches with invisible edges.
+##
+## @item "faceted"
+## Single colored patches with visible edges.
+##
+## @item "interp"
+## Color between patch vertices are interpolated and the patch edges are
+## invisible.
+## @end table
+##
+## If @var{ax} is given the shading is applied to axis @var{ax} instead
+## of the current axis.
 ## @end deftypefn
 
 ## Author: Kai Habel <kai.habel@gmx.de>