Please do not break API in minor releases

[spyder-bot]

From yarikop...@gmail.com on 2014-09-02T08:09:38Z

What version of the product are you using? On what operating system? 2.3.0

Please provide any additional information below

. Please do not break API in minor releases and go through a "deprecation" cycle happen you need to.

I am talking about

-def getsignaturesfromtext(text, objname):
+def getsignaturefromtext(text, objname):

which was done in v2.3.0beta1-81-g2b6c0c7 (sorry for a git treeish description, don't know hg at all)

Original issue: http://code.google.com/p/spyderlib/issues/detail?id=1953

[spyder-bot]

From ccordoba12 on 2014-09-02T06:37:10Z

I have two things to say about this:

1. I thought this function was only used by us. How are you using it as a library?
2. Our releases are minor and major at the same time. Minor in the sense that so far 2.1, 2.2, 2.3 haven't changed our plugin architecture (set in 2.0). They just represent improvements over the basic design. However, they are major in the sense that a huge amount of work goes into each release (more than a year of development, usually), and we usually do some refactorings in each release, as the one you encountered.

[spyder-bot]

From yarikop...@gmail.com on 2014-09-02T06:55:15Z

1. I am not even the one using it, but was sponsoring upload to Debian proper of a project which does use it and build failed because of this (during tests)

you could catch some other users of this function I guess with a search on github: https://github.com/search?q=getsignaturesfromtext&type=Code&utf8=%E2%9C%93 in debian we have python-spyderlib which does provide this functionality as a library

1. gotcha. still might be nice to carry out a deprecation cycle for any API change like this. I guess a decorator like in numpy might come handy https://github.com/numpy/numpy/blob/HEAD/numpy/lib/utils.py#L113

[spyder-bot]

From ccordoba12 on 2014-11-18T17:07:31Z

I'll fix this one in our next release, i.e. only for getsignaturefromtext.

I think it's really hard for me to report all API changes because we're mainly an application, not a library.

Status: Accepted
Labels: MS-v2.3.2 Cat-Miscelleneous

[spyder-bot]

From ccordoba12 on 2014-11-19T12:23:14Z

This issue was closed by revision cac7c82013ef .

Status: Fixed