Mercurial > hg > octave-lyh

diff scripts/plot/scatter.m @ 16814:64e7bb01fce2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Improve documentation for 2-D plot functions * doc/interpreter/plot.txi: Rewrite documentation around get/set. * libinterp/interpfcn/graphics.cc(Fget, Fset): Add seealso links. Add additional calling forms for get(). * scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m, scripts/plot/contourf.m, scripts/plot/errorbar.m, scripts/plot/gca.m, scripts/plot/gcf.m, scripts/plot/gco.m, scripts/plot/ishghandle.m, scripts/plot/loglogerr.m, scripts/plot/pareto.m, scripts/plot/pcolor.m, scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m, scripts/plot/polar.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/rose.m, scripts/plot/scatter.m, scripts/plot/semilogxerr.m, scripts/plot/semilogyerr.m, scripts/plot/sombrero.m, scripts/plot/stairs.m, scripts/plot/stem.m, scripts/plot/stem3.m: Improve docstrings.
author Rik <rik@octave.org>
date Sat, 22 Jun 2013 17:40:52 -0700
parents a0b313c17a6b
children 1cbdd14711c5
line wrap: on
line diff
--- a/scripts/plot/scatter.m
+++ b/scripts/plot/scatter.m
@@ -26,16 +26,16 @@
 ## @deftypefnx {Function File} {} scatter (@var{h}, @dots{})
 ## @deftypefnx {Function File} {@var{h} =} scatter (@dots{})
 ##
-## Plot a scatter plot of the data.  A marker is plotted at each point
+## Draw a scatter plot of the data.  A marker is plotted at each point
 ## defined by the points in the vectors @var{x} and @var{y}.  The size of
-## the markers used is determined by the @var{s}, which can be a scalar,
-## a vector of the same length of @var{x} and @var{y}.  If @var{s} is not
+## the markers used is determined by the @var{s}, which can be a scalar or
+## a vector of the same length as @var{x} and @var{y}.  If @var{s} is not
 ## given or is an empty matrix, then the default value of 8 points is used.
 ##
 ## The color of the markers is determined by @var{c}, which can be a string
 ## defining a fixed color; a 3-element vector giving the red, green,and blue
 ## components of the color; a vector of the same length as @var{x} that gives
-## a scaled index into the current colormap; or a @var{n}-by-3 matrix defining
+## a scaled index into the current colormap; or an @var{n}-by-3 matrix defining
 ## the colors of each of the markers individually.
 ##
 ## The marker to use can be changed with the @var{style} argument, that is a
@@ -43,7 +43,10 @@
 ## If the argument @code{"filled"} is given then the markers as filled.  All
 ## additional arguments are passed to the underlying patch command.
 ##
-## The optional return value @var{h} provides a handle to the patch object
+## The optional return value @var{h} is a graphics handle to the created patch
+## object.
+## 
+## Example:
 ##
 ## @example
 ## @group