[Pkg-octave-devel] Bug#492168: octave3.0: shading doc unclear and poor default shading

[David Bateman <adb014@gmail.com>]

Michael Goffioul wrote:
> On Sun, Jul 27, 2008 at 2:33 AM, David Bateman <adb014@gmail.com> wrote:
>> I'm not that much on an expert on the graphics code and what its
>> supposed to do, so don't really know the best clarification for this. If
>> you have any suggestions for how this text might be clarified then the
>> suggested changes would be appreciated.
> 
> faceted: edges visible, flat color
> flat: edges invisible, flat color
> interp: edges invisible, interpolated color
> 
> Michael.

I was kind of trying to cop out on supplying a changeset. Oh well what
about the attached then?

D.

# HG changeset patch
# User David Bateman <dbateman@free.fr>
# Date 1217191088 -7200
# Node ID 1f4df6d669cfc63aa0d7af63d3cee3518d7cfbbb
# Parent  e9ca46fb5739dcdad349bf99b04d1830d32e2229
Clarify help of the shading function

diff --git a/scripts/ChangeLog b/scripts/ChangeLog
--- a/scripts/ChangeLog
+++ b/scripts/ChangeLog
@@ -1,5 +1,7 @@ 2008-07-27  David Bateman  <dbateman@fre
 2008-07-27  David Bateman  <dbateman@free.fr>
 
+	* plot/shading.m: Clarify help string.
+	
 	* strings/regexptranslate.m: Add real documentation.
 	
 	* plot/contourf.m: Allow X,Y to be unequal vectors.
diff --git a/scripts/plot/shading.m b/scripts/plot/shading.m
--- a/scripts/plot/shading.m
+++ b/scripts/plot/shading.m
@@ -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>