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

Rename choose_formatter back to choose_encoder #796

Merged
merged 1 commit into from
Apr 8, 2022

Conversation

csmarchbanks
Copy link
Member

@csmarchbanks csmarchbanks commented Apr 8, 2022

Other libraries depend on this function and we did not mean to create a breaking change. Add a test to document that this is part of the API.

Fixes #795

@Starkteetje
Copy link

Note that this renaming is again a breaking change. If you want to avoid it, you could define one of the names as an alias to the other to get backwards-compatibility with the prior versions and 0.14 (though that's obviously ugly)

1 similar comment
@Starkteetje
Copy link

Note that this renaming is again a breaking change. If you want to avoid it, you could define one of the names as an alias to the other to get backwards-compatibility with the prior versions and 0.14 (though that's obviously ugly)

@csmarchbanks
Copy link
Member Author

Yeah, that is the case and I would prefer not to maintain the second function name forever. I am hoping that most people who are pinning versions are either pinning both or will upgrade to the patch version fairly quickly. Since the release has only been out for three days a bugfix to revert to the previous behavior seems reasonable to me?

@csmarchbanks csmarchbanks force-pushed the revert-unintentional-breaking-change branch 3 times, most recently from a7c476d to aeeb5d2 Compare April 8, 2022 14:36
@csmarchbanks
Copy link
Member Author

To avoid the second breaking change in 0.14.x I added choose_formatter back in with a deprecation notice. It will be removed as part of 0.15, but that at least gives everyone some time to use either.

Temporarily keep an alias so that choose_formatter will work for the
0.14.x release cycle.

Signed-off-by: Chris Marchbanks <[email protected]>
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

Successfully merging this pull request may close these issues.

Breaking change in most recent release
2 participants