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 FormatableType to FormattableType #813

Closed
breun opened this issue Sep 12, 2024 · 2 comments
Closed

Rename FormatableType to FormattableType #813

breun opened this issue Sep 12, 2024 · 2 comments
Assignees
Labels
in: core Core module meta model type: improvement Minor improvements
Milestone

Comments

@breun
Copy link

breun commented Sep 12, 2024

I'm not a native English speaker, but I believe that if something can be formatted, then it is 'formattable' rather than 'formatable', so I believe the class name FormatableType should be renamed to FormattableType.

@odrotbohm odrotbohm self-assigned this Sep 12, 2024
@odrotbohm odrotbohm added in: core Core module meta model type: improvement Minor improvements labels Sep 12, 2024
@odrotbohm
Copy link
Member

Good catch! Unfortunately, I think this will have to wait until 2.0 as it's a public type and fixing the typo will break existing clients.

@odrotbohm odrotbohm changed the title Rename FormatableType to FormattableType Rename FormatableType to FormattableType Sep 12, 2024
@breun
Copy link
Author

breun commented Sep 12, 2024

Maybe FormattableType can already be introduced before 2.0 next to Formatabletype by letting FormattableType extend FormatableType and marking FormatableType as deprecated for removal in 2.0?

Then Spring Modulith itself could already switch to FormattableType and existing users can also already switch before 2.0 if they want.

odrotbohm added a commit that referenced this issue Sep 20, 2024
As replacement for misspelled Formatable type.
@odrotbohm odrotbohm modified the milestones: 1.3 RC1, 1.3 M3 Sep 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: core Core module meta model type: improvement Minor improvements
Projects
None yet
Development

No branches or pull requests

2 participants