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

Added note about #670 #672

Merged
merged 1 commit into from
May 5, 2023
Merged

Added note about #670 #672

merged 1 commit into from
May 5, 2023

Conversation

k163377
Copy link
Contributor

@k163377 k163377 commented May 4, 2023

Added note regarding disruptive changes reported in #670.

@cowtowncoder
Is this an appropriate way to write annotations in such cases?
Please let me know if it should be reflected outside of the release notes.

@cowtowncoder
Copy link
Member

@k163377 Yes, this looks good to me.

In addition, it'd be good to add something on 2.15 Wiki release notes here:

https://github.com/FasterXML/jackson/wiki/Jackson-Release-2.15#changes-compatibility

(in whichever section makes most sense)

I try to keep these updated based on findings, things users report; so even if not initially included on actual release it should have complete set of information we have.

@k163377
Copy link
Contributor Author

k163377 commented May 5, 2023

@cowtowncoder
Thank you very much.
I probably do not have edit permission to your page, so could you please grant it to me?

@k163377 k163377 merged commit d508aa8 into FasterXML:2.16 May 5, 2023
@k163377 k163377 mentioned this pull request May 5, 2023
@k163377 k163377 deleted the fix-release-note branch May 5, 2023 04:09
@cowtowncoder
Copy link
Member

@cowtowncoder Thank you very much. I probably do not have edit permission to your page, so could you please grant it to me?

I sent you an invite, that should give access to this wiki and jackson-future-ideas repo wiki too.

@k163377
Copy link
Contributor Author

k163377 commented May 6, 2023

@pjfanning
Copy link
Member

pjfanning commented May 6, 2023

Can I suggest this instead:

jackson-module-kotlin changes the serialization result of getter-like functions starting with 'is'. For example, a function defined as fun isValid(): Boolean, which was previously output with the name valid, is now output with the name isValid (#670).

The term 'regression' implies that we will change the behaviour back to what it was before - that we are accepting it as a bug that needs to be fixed. Documenting it in the release notes then implies the opposite - that we are keeping the change. So, I think we should not use the word 'regression' here.

@k163377
Copy link
Contributor Author

k163377 commented May 6, 2023

@pjfanning
Thank you for pointing this out.

I am very sorry, but would you be able to help me with PR?
I have to rely on machine translation to read and write English, and I am not confident that I can express the nuances of such a case well.

@pjfanning
Copy link
Member

@k163377 I modified the wiki. If anyone feels like my changes are inaccurate, feel free to further edit them.

k163377 added a commit that referenced this pull request May 6, 2023
Changed wording based on comments in #672
@k163377 k163377 mentioned this pull request May 6, 2023
@k163377
Copy link
Contributor Author

k163377 commented May 6, 2023

@pjfanning
Thank you very much.
It looks very good.

I have submitted a PR regarding the release note.
#676

@cowtowncoder
Copy link
Member

Thank you @k163377 and @pjfanning ! Good point on semantics of regression: using optimal term helps avoid misunderstanding by users.

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.

3 participants