Documentation update #476
Merged
Documentation update #476
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
approved these changes
Dec 22, 2020
bnavigator
reviewed
Dec 22, 2020
control/statefbk.py
Outdated
| @@ -373,9 +374,9 @@ def lqr(*args, **keywords): | |||
|
|
|||
| Returns | |||
| ------- | |||
| K: 2D array | |||
| K: 2D array (or matrix) | |||
There was a problem hiding this comment.
numpydoc:
Suggested change
| K: 2D array (or matrix) | |
| K : 2D array (or matrix) |
Same for all the other functions in this file, which are a mix of numpydoc and non-numpydoc right now.
bnavigator
reviewed
Dec 22, 2020
control/statefbk.py
Outdated
Comment on lines
393
to
398
| Notes | ||
| ----- | ||
| The return type for `K` and `S` depends on the default class set for | ||
| state space operations. By default, this is the Numpy `matrix` | ||
| class in this release, but this can be reconfigured using the | ||
| :func:`~control.use_numpy_matrix` function. |
There was a problem hiding this comment.
This is also true for most of the other functions in this file. Maybe a general note referenced here and in those functions would be preferable. Cf. #439
…c style fixes + PEP8
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 has a number of small documentation updates the I collected over time. All minor.