- Notifications
You must be signed in to change notification settings - Fork441
Update documentation, processing of root_locus kvect keyword#989
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Update documentation, processing of root_locus kvect keyword#989
Uh oh!
There was an error while loading.Please reload this page.
Conversation
coveralls commentedApr 5, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
control/rlocus.py Outdated
kvect keyword argument if provided). | ||
(legacy) If the `plot` keyword is given, returns the closed-loop | ||
root locations, arranged such that each row corresponds to a gain | ||
in gains, and the array of gains (ame as gains keyword argument if |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
ingains,andthearrayofgains (ameasgainskeywordargumentif | |
ingains,andthearrayofgains (sameas`gains`keywordargumentif |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This is good to merge, except for the misprint identified by@bnavigator (the misprint existed before this PR, but might as well fix it).
This PR addresses issue#987, which was partially fixed in#988, by consistently using the keyword
gains
instead ofkvect
in the root locus commands. In addition, if thekvect
keyword is used, a warning is generated indicating thatkvect
has been deprecated andgains
should be used instead.Also include some minor reformatting of docstrings in rlocus.py.