ts4nfdi / terminology-service-suite

The SemLookP Widgets project is a collection of interactive widgets designed to ease the integration of terminology service functions into third-party applications.
https://ts4nfdi.github.io/terminology-service-suite/comp/latest/
MIT License
12 stars 2 forks source link

Not all breaking changes are documented (updating 1.9 -> 2.1.0) #99

Closed vera closed 1 day ago

vera commented 4 days ago

I just updated from v1.9 to v2.1. The only breaking change that is documented for the update to 2.x is the new name and repo URL. However, I also found the following changes that broke my existing code:

Maybe this could be added to the list of breaking changes included in 2.0, since that is most likely where people will check when updating the package. (even though the changes were probably actually made in other versions)

For future versions, it would be good if all changes to the interface (param names and types) would be marked as breaking.

jusa3 commented 3 days ago

Sorry for the trouble and thanks for reporting! Added the mentioned breaking changes and a developer note to the readme.

vera commented 1 day ago

Thank you!