Skip to content

Commit 2646ead

Browse files
committed
Fix margin() documentation to address issue #195
1 parent 601b581 commit 2646ead

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

control/margins.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -340,18 +340,18 @@ def margin(*args):
340340
Gain margin
341341
pm : float
342342
Phase margin (in degrees)
343-
Wcg : float
344-
Gain crossover frequency (corresponding to phase margin)
345-
Wcp : float
346-
Phase crossover frequency (corresponding to gain margin) (in rad/sec)
343+
wg: float or array_like
344+
Gain margin crossover frequency (where phase crosses -180 degrees)
345+
wp: float or array_like
346+
Phase margin crossover frequency (where gain crosses 0 dB)
347347
348348
Margins are of SISO open-loop. If more than one crossover frequency is
349349
detected, returns the lowest corresponding margin.
350350
351351
Examples
352352
--------
353353
>>> sys = tf(1, [1, 2, 1, 0])
354-
>>> gm, pm, Wcg, Wcp = margin(sys)
354+
>>> gm, pm, wg, wp = margin(sys)
355355
356356
"""
357357
if len(args) == 1:

0 commit comments

Comments
 (0)