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

Fix typos method and parameter #8

Merged
merged 8 commits into from
Dec 27, 2024
Merged

Conversation

bact
Copy link
Collaborator

@bact bact commented Dec 17, 2024

  • enum: Unkown -> Unknown
  • method: getCaseSensisitiveId -> getCaseSensitiveId
    • parameter: caseInsensisitiveId -> caseInsensitiveId
  • Add default method getCaseSensisitiveId with the same parameter spelling caseInsensisitiveId for backward compatibility
    • This default method is implemented inside the interface, so it will be available to any class implements the interface without the need to actually implemented it (to avoid breaking)

Note: as the enum and the method are public, this change will break any code that use any of them

Method getCaseSensisitiveId is still available and can be called the same way.

Defer the renaming of enum for now, just add a comment to the code.

Note: as the enum and the method are public, this change will break any code that use any of them

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Copy link
Collaborator Author

bact commented Dec 17, 2024

If this change is accepted, further updates of names are needed in https://github.com/spdx/Spdx-Java-Library

@goneall
Copy link
Member

goneall commented Dec 17, 2024

I'm concerned about the breaking changes to the public methods - so I'll label this for the next major release.

@goneall goneall added this to the 2.0 milestone Dec 17, 2024
@bact bact changed the title Fix typos in enum, method, and parameter Fix typos method and parameter Dec 19, 2024
@bact
Copy link
Collaborator Author

bact commented Dec 19, 2024

I'm concerned about the breaking changes to the public methods - so I'll label this for the next major release.

@goneall I have removed the enum renaming and add the default method to the interface (per discussion here: spdx/Spdx-Java-Library#266 (comment) ) - will this address the backward compatibility concern?

Also deferring the enum renaming.

@bact bact requested a review from goneall December 19, 2024 11:39
Copy link
Member

@goneall goneall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this should work - I'll go ahead and approve / merge in. If it turns out to break something downstream, we can fix it before the next release.

@goneall goneall merged commit 13df3e0 into spdx:main Dec 27, 2024
3 checks passed
@bact bact deleted the fix-enum-spelling branch December 27, 2024 22:06
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.

2 participants