[Octave-cvsupdate] SF.net SVN: octave:[10896] trunk/octave-forge/main/control/devel/ sensitivity.m

[<par...@us...>]

Revision: 10896
          http://octave.svn.sourceforge.net/octave/?rev=10896&view=rev
Author:   paramaniac
Date:     2012-08-23 07:43:52 +0000 (Thu, 23 Aug 2012)
Log Message:
-----------
control: minor doc enhancement

Modified Paths:
--------------
    trunk/octave-forge/main/control/devel/sensitivity.m

Modified: trunk/octave-forge/main/control/devel/sensitivity.m
===================================================================
--- trunk/octave-forge/main/control/devel/sensitivity.m	2012-08-23 07:30:41 UTC (rev 10895)
+++ trunk/octave-forge/main/control/devel/sensitivity.m	2012-08-23 07:43:52 UTC (rev 10896)
@@ -19,7 +19,10 @@
 ## @deftypefn{Function File} {@var{Ms} =} sensitivity (@var{L})
 ## @deftypefnx{Function File} {@var{Ms} =} sensitivity (@var{P}, @var{C})
 ## @deftypefnx{Function File} {@var{Ms} =} sensitivity (@var{P}, @var{C1}, @var{C2}, @dots{})
-## Return sensitivity margin @var{Ms}.
+## Return sensitivity margin @var{Ms}.  The quantity @var{Ms} is
+## simply the inverse of the shortest distance from the Nyquist
+## curve to the critical point -1.  Reasonable values of @var{Ms}
+## are in the range from 1.3 to 2.
 ##
 ## @strong{Inputs}
 ## @table @var

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.