Skip to content

Commit 17bc2a8

Browse files
Apply suggestions from code review
doctoring fixes to adhere to numpydoc convention Co-authored-by: Ben Greiner <code@bnavigator.de>
1 parent d8fbaa0 commit 17bc2a8

2 files changed

Lines changed: 15 additions & 8 deletions

File tree

control/statesp.py

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -474,8 +474,9 @@ def slycot_horner(self, s):
474474
Complex frequency
475475
476476
Returns
477-
output : array of size (outputs, inputs, len(s))
478-
477+
-------
478+
output : (outputs, inputs, len(s)) complex ndarray
479+
Frequency response
479480
"""
480481
from slycot import tb05ad
481482

@@ -519,11 +520,14 @@ def horner(self, s):
519520
for a more user-friendly interface.
520521
521522
Parameters
522-
s : array-like
523+
----------
524+
s : array_like
525+
Complex frequencies
523526
524527
Returns
525-
output : array of size (outputs, inputs, len(s))
526-
528+
-------
529+
output : (outputs, inputs, len(s)) complex ndarray
530+
Frequency response
527531
"""
528532
s_arr = np.array(s, ndmin=1) # force to be an array
529533
# Preallocate

control/xferfcn.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,11 +233,14 @@ def horner(self, s):
233233
for a more user-friendly interface.
234234
235235
Parameters
236-
s : array-like
236+
----------
237+
s : array_like
238+
Complex frequencies
237239
238240
Returns
239-
output : array of size (outputs, inputs, len(s))
240-
241+
-------
242+
output : (outputs, inputs, len(s)) complex ndarray
243+
Frequency response
241244
"""
242245
s_arr = np.array(s, ndmin=1) # force to be an array
243246
out = empty((self.outputs, self.inputs, len(s_arr)), dtype=complex)

0 commit comments

Comments
 (0)