[SciPy-Dev] scipy.signal function naming

Eric Larson larson.eric.d at gmail.com
Tue Feb 24 09:29:58 EST 2015


+1 for more readable names, and putting the MATLAB-equivalent names in the
docstring. Usually when I'm looking for a MATLAB-equivalent function, I'll
do something like google "python upfirdn" or "scipy upfirdn", so if
"upfirdn" were in the docstring of "rate_resample" it would be also be
found.

Eric


On Mon, Feb 23, 2015 at 9:47 PM, Ralf Gommers <ralf.gommers at gmail.com>
wrote:

> Hi,
>
> Historically many names in scipy.signal have followed Matlab, which
> typically chooses short but very nondescriptive names. I would prefer to
> not keep doing that but instead choose readable names that fit with the
> rest of Scipy and Python. Recent examples from PRs, with in brackets a
> proposed alternative:
>
> grpdelay (group_delay) - https://github.com/scipy/scipy/pull/4549
> place (place_poles) - https://github.com/scipy/scipy/pull/4295
> ctrb (controllalbility_matrix) - https://github.com/scipy/scipy/pull/4515
> obsv (observability_matrix) - https://github.com/scipy/scipy/pull/4515
> upfirdn (rate_resample ?) - just discussed on list
>
> Thoughts?
>
> Ralf
>
>
>
>
> _______________________________________________
> SciPy-Dev mailing list
> SciPy-Dev at scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20150224/7a63515e/attachment.html>


More information about the SciPy-Dev mailing list