jackson-core icon indicating copy to clipboard operation
jackson-core copied to clipboard

Fix typos

Open TheJavaGuy opened this issue 1 year ago • 2 comments

Fixes various typos (mostly of can not -> cannot kind). Rationale is given in https://writingexplained.org/cannot-or-can-not-difference

TheJavaGuy avatar Sep 23 '24 10:09 TheJavaGuy

Changing the text of an exception can break user's code. In the real world, users do things like catch exceptions and try to parse the text. I'm not saying this is a good thing to do but it happens. can not and cannot are both valid in English - so I say it is not worth the risk of adding this change.

pjfanning avatar Sep 23 '24 11:09 pjfanning

100% agree with @pjfanning: I'm fine with changes to Javadocs, but let's not change exception messages for 2.x.

So would it be possible to change this PR to only have Javadoc changes. Additionally if it feels useful -- I am non-native english speaker so do not have a gut feelings -- could have another PR against master (Jackson 3.0) for Exception message changes: with 3.0 there are API changes anyway and we could make the change.

cowtowncoder avatar Sep 23 '24 17:09 cowtowncoder

Would be happy to apply just Javadoc changes...

cowtowncoder avatar Nov 05 '24 04:11 cowtowncoder

Applied Javadoc/comment-only changes to 2.18. The rest can't go in 2.18, but I am thinking that if we want these, they really need to in master (for Jackson 3.0). This since while some changes are ok with minor (2.19) versions, I think these changes have a bit too high a chance to break some brittle code somewhere to warrant the risk.

This cannot be done with rebase unfortunately, but if anyone wants to take a stab at that I'd be happy to review and merge. Leaving this PR open as reminder for now.

cowtowncoder avatar Jan 27 '25 00:01 cowtowncoder

Ok, made in-comment changes in 2.18, and everything in 3.0/master. Closing this PR.

Thank you @TheJavaGuy for suggesting this!

cowtowncoder avatar Apr 07 '25 22:04 cowtowncoder