ilayn / harold

An open-source systems and controls toolbox for Python3
MIT License
173 stars 19 forks source link

DOC: Update haroldpolyadd function #36

Closed whzup closed 6 years ago

whzup commented 6 years ago

Updated the haroldpolyadd function. It now trims the zeros of the output instead the zeros of the input. Improved the docstring with a parameter and return list.

If you like these changes I can change the haroldpolymult function as well.

ilayn commented 6 years ago

Just to clarify, do you want to trim the input or output or both ? I am wondering if all options should be exposed with trim_input and trim_output.

The use cases are (as far as I can see):

whzup commented 6 years ago

Hmm, well the question is whether or not one or the other is necessary 🤔 Although, if you provide default True's it might actually be no problem. Both would do it as well 👍

ilayn commented 6 years ago

I played with different versions and it has a bit of effect on the rest of the library since I do a lot of stuff regarding the MIMO transfer functions. Hence it is a bit of a bigger surgery.

Do you mind keeping this PR to the docstrings?

Then it is easier to chop the rest into smaller pieces later.

ilayn commented 6 years ago

@whzup Sorry it took a while to spare some time for this. Now it should be a bit better to work on. I've enabled the intersphinx extension to link automatically to Numpy.

ilayn commented 6 years ago

I've closed and opened to try to trigger Travis,

ilayn commented 6 years ago

All green. Merging. Thanks @whzup !