Mercurial > octave
changeset 27494:eeb2275424bc stable
polar.m: Document that input is expected to be in radians (bug #57052).
* polar.m: Add clarifying documentation that input is in radians. Add @seealso
link to cart2pol.
| author | doug<doug.dastew@gmail.com> |
|---|---|
| date | Mon, 14 Oct 2019 10:50:19 -0400 |
| parents | 616b844e903a |
| children | 910737d41605 8c9924a425db |
| files | scripts/plot/draw/polar.m |
| diffstat | 1 files changed, 6 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/plot/draw/polar.m Mon Oct 14 17:21:28 2019 -0700 +++ b/scripts/plot/draw/polar.m Mon Oct 14 10:50:19 2019 -0400 @@ -25,6 +25,11 @@ ## @deftypefnx {} {@var{h} =} polar (@dots{}) ## Create a 2-D plot from polar coordinates @var{theta} and @var{rho}. ## +## The input @var{theta} is assumed to be radians and is converted to degrees +## for plotting. If you have degrees then you must convert +## (@pxref{XREFcart2pol,,cart2pol}) to radians before passing the data to this +## function. +## ## If a single complex input @var{cplx} is given then the real part is used ## for @var{theta} and the imaginary part is used for @var{rho}. ## @@ -44,7 +49,7 @@ ## @code{xtick}, @code{ytick}. The first is a list of tick locations in the ## radial (rho) direction; The second is a list of tick locations in the ## angular (theta) direction specified in degrees, i.e., in the range 0--359. -## @seealso{rose, compass, plot} +## @seealso{rose, compass, plot, cart2pol} ## @end deftypefn ## Author: jwe