Repository navigation
inconsistent kwarg klist/kvect/gains in rlocus doc #998
Description
The first line of the docstring for rlocus suggests that there's a kwarg klist,
"""rlocus(sys[, klist, xlim, ylim, ...])
python-control/control/matlab/wrappers.py
Line 200 in e4a03e8
but in the list of parameters it's kvect.
python-control/control/matlab/wrappers.py
Line 212 in e4a03e8
They're all just passed on to root_locus_plot anyway
python-control/control/matlab/wrappers.py
Line 247 in e4a03e8
and it's expecting kvect, or, really, gains
python-control/control/rlocus.py
Line 163 in e4a03e8
Activity
gdmcbain commentedon May 9, 2024
This is miscalled in pymoca/pymoca test/notebooks/Spring,ipynb:
"control.rlocus(ss[0,0], klist=pl.logspace(-2,1,1000));\n",bnavigator commentedon May 9, 2024
Only for the MATLAB wrapper though. The MATLAB docs call the parameter
kby the way.Using a MATLAB wrapper with a python kwarg is somehow unusual.
PR welcome.
The MATLAB wrapper is not part of that call. The kwarg for control.rlocus has been
kvectfor 13 years: 8ebb73b.rlocus(kvect) python-control#998
klist->gains python-control#998
gdmcbain commentedon May 10, 2024
Ah, yes, sorry I see now that
control.rlocusdoesn't callcontrol.matlab.wrappers.rlocusat all but rathercontrol.root_locus_plot; I had overlooked this:python-control/control/rlocus.py
Line 452 in e4a03e8
My real problem was pymoca/pymoca#324 so I'll look over there at fixing that. I'm not presently concerned with
control.matlab, but I'll turn in the PR as requested, while I'm at it.