Backwards incompatible changes made 0.1.0 to 0.1.2

[0Hughman0]

Hi,

It seems some backwards incompatible changes were made between version 0.1.0 and 0.1.2.

My code for 0.1.0 made use of

lumispy.signals.luminescence_spectrum.LumiSpectrum.background_subtraction

in 0.1.2 this is now broken as this method has been removed. It seems this functionality has now been moved to:

lumispy.signals.luminescence_spectrum.LumiSpectrum.remove_background_from_file

However, it seems the implementation of this method is different to the background_subtraction method from 0.1.0 as swapping the two doesn't seem to fix the issue.

In general, my expectations for versioning are that a bump in patch number i.e. 0.1.0 to 0.1.2 would only be to incorporate backwards compatible bug fixes, as described in the semantic versioning docs:

https://semver.org/

In general my expectations for removing features like lumispy.signals.luminescence_spectrum.LumiSpectrum.background_subtraction would be that moving this would require a major bump in version number, and ideally a deprecation warning added during a minor bump as a warning.

That all said, I am very pleased at the decision to change the name from a noun to a verb!

Thanks for your work on this package, it's super cool, hope to add some features at some point 😁.

Hugh

[0Hughman0]

Hmmm, looking a bit more, it seems I had some sort of pre-release version of lumispy installed because I just tried to manually get version 0.1.0 from pip and the API is different to the on I had before (which was also labelled 0.1.0).

[jlaehne]

Yes, you must have had a pre-release version directly from github - I think before releasing v0.1.0 we did not add a dev ending to the version number on github. Sorry for the confusion.

[ericpre]

Sorry, if we were careless in breaking the API in a patch release, lumispy's structure was not well settled and there was some significant changes recently and now we hope that we have a solid base. It means that further intentional API breakage shouldn't occur in the future!

In my opinion, there are a lot of low hanging fruits in lumispy in term of implementing more convenience functions for background removal, model fitting specialised for raman data, etc. so there is room for "easy" and very useful contributions. Please don't hesitate to get in touch, we can provide help and guidance when reviewing!