8000 Documentation update (#476) · python-control/python-control@120a926 · GitHub
[go: up one dir, main page]

Skip to content

Commit 120a926

Browse files
authored
Documentation update (#476)
* fix typos, equation numbering in doc/flatsys.rst * small updates (including numpydoc fixes) to statefbk.py, mateqn.py docstrings * update setup.py contact info * small fixes to iosys docstrings (from samlaf) * update lqr() return type documentation (addresses #418) * added 2D array/matrix note to all functions using _ssmatrix * PEP8 formatting updates for statefbk.py, mateqn.py (while I was at it)
1 parent e525ff6 commit 120a926

File tree

6 files changed

+406
-271
lines changed

6 files changed

+406
-271
lines changed

control/config.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,11 @@ class and functions. If flat is `False`, then matrices are
154154
of the Numpy `matrix` class. Set `warn` to false to omit display of
155155
the warning message.
156156
157+
Notes
158+
-----
159+
Prior to release 0.9.x, the default type for 2D arrays is the Numpy
160+
`matrix` class. Starting in release 0.9.0, the default type for state
161+
space operations is a 2D array.
157162
"""
158163
if flag and warn:
159164
warnings.warn("Return type numpy.matrix is soon to be deprecated.",
@@ -179,4 +184,4 @@ def use_legacy_defaults(version):
179184
third_digit = int(version[4])
180185
use_numpy_matrix(True) # alternatively: set_defaults('statesp', use_numpy_matrix=True)
181186
else:
182-
raise ValueError('''version number not recognized. Possible values range from '0.1' to '0.8.4'.''')
187+
raise ValueError('''version number not recognized. Possible values range from '0.1' to '0.8.4'.''')

control/iosys.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -780,7 +780,7 @@ def __init__(self, syslist, connections=[], inplist=[], outlist=[],
780780
781781
The InterconnectedSystem class is used to represent an input/output
782782
system that consists of an interconnection between a set of subystems.
783-
The outputs of each subsystem can be summed together to to provide
783+
The outputs of each subsystem can be summed together to provide
784784
inputs to other subsystems. The overall system inputs and outputs can
785785
be any subset of subsystem inputs and outputs.
786786

0 commit comments

Comments
 (0)
0