Skip to content

Commit ebd3904

Browse files
committed
add grid arguments in docstring.
1 parent 5e47d1f commit ebd3904

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

control/rlocus.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959

6060
# Main function: compute a root locus diagram
6161
def root_locus(sys, kvect=None, xlim=None, ylim=None, plotstr='-', Plot=True,
62-
PrintGain=True, grid = False):
62+
PrintGain=True, grid=False):
6363
"""Root locus plot
6464
6565
Calculate the root locus by finding the roots of 1+k*TF(s)
@@ -77,10 +77,12 @@ def root_locus(sys, kvect=None, xlim=None, ylim=None, plotstr='-', Plot=True,
7777
ylim : tuple or list, optional
7878
control of y-axis range
7979
Plot : boolean, optional (default = True)
80-
If True, plot magnitude and phase
80+
If True, plot root locus diagram.
8181
PrintGain: boolean (default = True)
8282
If True, report mouse clicks when close to the root-locus branches,
8383
calculate gain, damping and print
84+
grid: boolean (default = False)
85+
If True plot s-plane grid.
8486
8587
Returns
8688
-------

0 commit comments

Comments
 (0)