8000 Added 2D array/matrix note to all functions using _ssmatrix + numpydo… · python-control/python-control@6ff59f0 · GitHub
[go: up one dir, main page]

Skip to content

Commit 6ff59f0

Browse files
committed
Added 2D array/matrix note to all functions using _ssmatrix + numpydoc style fixes + PEP8
1 parent 3e6347f commit 6ff59f0

File tree

3 files changed

+379
-252
lines changed

3 files changed

+379
-252
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'.''')

0 commit comments

Comments
 (0)
0