help-octave
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: bar and hist


From: Kai Habel
Subject: Re: bar and hist
Date: Thu, 01 Nov 2007 21:41:25 +0100
User-agent: Thunderbird 2.0.0.6 (X11/20070801)

John W. Eaton schrieb:
> On  1-Nov-2007, Kai Habel wrote:
>
> | It seems the help string of bar is not up to date. 
>
> Would someone please submit a patch to fix this problem?
>
> Thanks,
>
> jwe
>
>   
O.k. here are patches for bar.m and barh.m.

Kai

ChangeLog:

2007-11-01 Kai Habel  <address@hidden>

  * plot/bar.m, plot/barh.m: Fix for help text
 

--- bar.m.orig  2007-11-01 20:25:42.000000000 +0100
+++ bar.m       2007-11-01 21:21:08.000000000 +0100
@@ -18,37 +18,30 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} address@hidden =} bar (@var{x}, @var{y}, 
@var{p1}, @var{v1}, @dots{})
-## @deftypefnx {Function File} address@hidden, @var{yb}] =} bar (@dots{})
-## Given two vectors of x-y data, @code{bar} produce a bar graph.
+## @deftypefn {Function File}  bar (@var{x}, @var{y})
+## @deftypefnx {Function File} bar (@var{y})
+## @deftypefnx {Function File} bar (@var{x}, @var{y}, @var{w})
+## @deftypefnx {Function File} bar (@var{x}, @var{y}, @var{w}, @var{style})
+## @deftypefnx {Function File} address@hidden =} bar (...,@var{prop}, 
@var{val})
+##
+## Given two vectors of x-y data, @code{bar} produces a bar graph.
 ##
 ## If only one argument is given, it is taken as a vector of y-values
 ## and the x coordinates are taken to be the indices of the elements.
 ##
+## The default width of 0.8 for the bars can be changed using @var{w}. 
+##
 ## If @var{y} is a matrix, then each column of @var{y} is taken to be a
 ## separate bar graph plotted on the same graph. By default the columns
 ## are plotted side-by-side. This behavior can be changed by the @var{style}
 ## argument, which can take the values @code{"grouped"} (the default),
 ## or @code{"stacked"}.
 ##
-## If two output arguments are specified, the data are generated but
-## not plotted.  For example,
+## The optional return value @var{h} provides a handle to the patch object.
+## Properties of the patch graphic object can be changed using 
+## @var{prop}, @var{val} pairs
 ##
-## @example
-## bar (x, y);
-## @end example
-##
-## @noindent
-## and
-##
-## @example
-## [xb, yb] = bar (x, y);
-## plot (xb, yb);
-## @end example
-##
-## @noindent
-## are equivalent.
-## @seealso{hbar, plot}
+## @seealso{barh, plot}
 ## @end deftypefn
 
 ## Author: jwe
--- barh.m.orig 2007-11-01 21:25:02.000000000 +0100
+++ barh.m      2007-11-01 21:28:36.000000000 +0100
@@ -17,36 +17,29 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} address@hidden =} barh (@var{x}, @var{y}, 
@var{style})
-## @deftypefnx {Function File} address@hidden, @var{yb}] =} barh (@dots{})
-## Given two vectors of x-y data, @code{bar} produce a horizontal bar graph.
+## @deftypefn {Function File}  barh (@var{x}, @var{y})
+## @deftypefnx {Function File} barh (@var{y})
+## @deftypefnx {Function File} barh (@var{x}, @var{y}, @var{w})
+## @deftypefnx {Function File} barh (@var{x}, @var{y}, @var{w}, @var{style})
+## @deftypefnx {Function File} address@hidden =} barh (...,@var{prop}, 
@var{val})
+##
+## Given two vectors of x-y data, @code{barh} produces a horizontal bar graph.
 ##
 ## If only one argument is given, it is taken as a vector of y-values
 ## and the x coordinates are taken to be the indices of the elements.
 ##
+## The default width of 0.8 for the bars can be changed using @var{w}. 
+##
 ## If @var{y} is a matrix, then each column of @var{y} is taken to be a
 ## separate bar graph plotted on the same graph. By default the columns
 ## are plotted side-by-side. This behavior can be changed by the @var{style}
 ## argument, which can take the values @code{"grouped"} (the default),
 ## or @code{"stacked"}.
 ##
-## If two output arguments are specified, the data are generated but
-## not plotted.  For example,
-##
-## @example
-## barh (x, y);
-## @end example
-##
-## @noindent
-## and
-##
-## @example
-## [xb, yb] = barh (x, y);
-## plot (xb, yb);
-## @end example
+## The optional return value @var{h} provides a handle to the patch object.
+## Properties of the patch graphic object can be changed using 
+## @var{prop}, @var{val} pairs
 ##
-## @noindent
-## are equivalent.
 ## @seealso{bar, plot}
 ## @end deftypefn
 

reply via email to

[Prev in Thread] Current Thread [Next in Thread]