Skip to content

Documentation update #476

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
murrayrm merged 7 commits into from
Dec 24, 2020
Merged

Documentation update #476

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
802b47b
DOC: fix typos, equation numbering in doc/flatsys.rst
murrayrm Jan 5, 2020
7b9d1a9
small updates to statefbk.py docstrings
murrayrm Jan 18, 2020
4f49094
update setup.py contract info
murrayrm Jan 20, 2020
17c1840
small fixes to iosys docstrings (from samlaf)
murrayrm May 17, 2020
97c4a65
TRV: fix indentation in docstring
murrayrm Dec 22, 2020
3e6347f
update lqr() return type documentation (addresses #418)
murrayrm Dec 22, 2020
6ff59f0
Added 2D array/matrix note to all functions using _ssmatrix + numpydo…
murrayrm Dec 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update lqr() return type documentation (addresses #418)
  • Loading branch information
@murrayrm
murrayrm committed Dec 22, 2020
commit 3e6347f2f4f18817a822546af13d49c2d63d1d93
10 changes: 8 additions & 2 deletions control/statefbk.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,9 +374,9 @@ def lqr(*args, **keywords):

Returns
-------
K: 2D array
K: 2D array (or matrix)

@bnavigator bnavigator Dec 22, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

State feedback gains
S: 2D array
S: 2D array (or matrix)
Solution to Riccati equation
E: 1D array
Eigenvalues of the closed loop system
Expand All @@ -390,6 +390,12 @@ def lqr(*args, **keywords):
--------
lqe

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.

@bnavigator bnavigator Dec 22, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

"""

# Make sure that SLICOT is installed
Expand Down