Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modification not backward compatible in XsdRestriction (xsdParser 1.2.5+) #57

Closed
mttfranci opened this issue Feb 19, 2024 · 4 comments
Closed

Comments

@mttfranci
Copy link

First of all, I would like to thank you for providing this very usuful xsd parser.

Describe the bug
Upgrading xsdParser version from 1.2.4 to 1.2.6, the return type of method getPattern() has been changed. (from single value to list).
Here is the commit introducing the breaking change :
859d897
This broke my software's build.

Expected behavior
Creating new method for new return type, flag the old one as deprecated and wait some time before removal.
Maybe using some sort of convention for breaking changes, for instance as in
semantic versioning
(Changing the major version when a new release is not backward compatible)

Library Version
Upgrading from 1.2.4 to 1.2.6

Additional context
Here is a sample of the code that broke :
AutodocAttribute line 95

Thanks again!

@lcduarte
Copy link
Member

Hello,

Thanks for using the library! Yeah, you are right, I've accepted the PR and didn't think about backwards compatibility. I've released a new version, 1.2.7, with the old method as it was before the change and a new method getPatterns, so everyone should be happy :)

@SimonCockx
Copy link
Contributor

SimonCockx commented Feb 20, 2024

@lcduarte One more thing: could the old method be deprecated? I think making the patterns a list is a good change, but right now library users will only see this change "by coincidence". Adding a deprecated warning will make them aware of the good work being done here. :)

@lcduarte
Copy link
Member

@SimonCockx I think the current solution is valid, both options are valid to be used, if the someone needs the list he'll look if another method is available.

fugerit79 added a commit to fugerit-org/fj-doc that referenced this issue Feb 20, 2024
@fugerit79
Copy link
Contributor

Thank you very much @lcduarte. Already updated and working properly.
Thanks for your work and the fast feedback

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants