Fix #45 - make gain vector optional in root_locus#54
Merged
Conversation
Note that one cannot use arbitrary section headings in numpydoc. For instance, the section headings "Usage", "Keywords", and "Return Values" are not valid section headings, and would give warnings when building documentation. In addition, the routine matlab.tfdata was documented incorrectly (the documentated behavior did not match the actual behavior when keyword arguments were used).
2 similar comments
murrayrm
added a commit
that referenced
this pull request
Apr 5, 2015
Fix #45 - make gain vector optional in root_locus Checked and this looks OK. For posterity, what was the reason for getting rid of some of the **kw arguments: -def tfdata(sys, **kw): +def tfdata(sys):
Contributor
Author
There was a problem hiding this comment.
The keyword arguments inputs and outputs to _convertToTransferFunction apply only if sys is a SISO system, and the result is to return a MIMO transfer function with the specified number of inputs and outputs. So this is different from what is in the documentation string above, and since this routine just extracts the numerator and denominator of a transfer function, there would never be a need to convert a SISO system to MIMO.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
As a consequence of this change,
root_locusnow returns two items, the roots and the gains used (consistent withmatlab.rlocus).This PR also fixes some mistakes I found in the documentation.