Update documentation, processing of root_locus kvect keyword #989
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bnavigator
reviewed
Apr 5, 2024
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.
Suggested change
| in gains, and the array of gains (ame as gains keyword argument if | |
| in gains, and the array of gains (same as `gains` keyword argument if |
slivingston
approved these changes
Apr 6, 2024
There was a problem hiding this comment.
This is good to merge, except for the misprint identified by @bnavigator (the misprint existed before this PR, but might as well fix it).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses issue #987, which was partially fixed in #988, by consistently using the keyword
gainsinstead ofkvectin the root locus commands. In addition, if thekvectkeyword is used, a warning is generated indicating thatkvecthas been deprecated andgainsshould be used instead.Also include some minor reformatting of docstrings in rlocus.py.