Mercurial > hg > octave-nkf
diff scripts/plot/rectangle.m @ 12761:13bcd62824a7 stable
doc: Add documentation for gmres, rectangle to manual
linear-algebra/module.mk: Add gmres.m to list of functions.
gmres.m: Correct spelling in @seealso reference.
octave.texi: Add reference to new menu for 2D Geometric Shapes.
plot.txi: Add new menu for 2D Geometric Shapes. Add rectangle function.
rectangle.m: Improve DOCSTRING
aspell-octave.en.pws: Add spelling exception for PGMRES
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 20 Jun 2011 10:17:20 -0700 |
parents | fb93b94dfc82 |
children | f511bfe00d14 |
line wrap: on
line diff
--- a/scripts/plot/rectangle.m +++ b/scripts/plot/rectangle.m @@ -26,14 +26,14 @@ ## ## Draw rectangular patch defined by @var{pos} and @var{curv}. The variable ## @code{@var{pos}(1 : 2)} defines the lower left-hand corner of the patch -## and @code{@var{pos}(3 : 4)} its width and height. By default the value of -## @var{pos} is @var{[0, 0, 1, 1]}. +## and @code{@var{pos}(3 : 4)} defines its width and height. By default, the +## value of @var{pos} is @code{[0, 0, 1, 1]}. ## ## The variable @var{curv} defines the curvature of the sides of the rectangle -## and it can be a scalar or two-element vector with values between 0 and 1. -## A value of 0 represents no curvature of the side, where as a value of 1 -## means that the rectangular side is entirely curved into an arc of a circle. -## If curvature is a two-element vector, then the first element is the +## and may be a scalar or two-element vector with values between 0 and 1. +## A value of 0 represents no curvature of the side, whereas a value of 1 +## means that the side is entirely curved into the arc of a circle. +## If @var{curv} is a two-element vector, then the first element is the ## curvature along the x-axis of the patch and the second along y-axis. ## ## If @var{curv} is a scalar, it represents the curvature of the shorter of the