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

"image-label" not camel case #109

Open
constantinpape opened this issue Mar 17, 2022 · 3 comments
Open

"image-label" not camel case #109

constantinpape opened this issue Mar 17, 2022 · 3 comments

Comments

@constantinpape
Copy link
Contributor

constantinpape commented Mar 17, 2022

Most of the names in the spec are snake case camel case. However, image-label is not, see https://ngff.openmicroscopy.org/latest/#label-md. Is there a particular reason for this?
If not, could it still be changed? I find it fairly confusing.
(But I understand that you might not want to do it for legacy reasons; I don't feel super strongly about it.)

Edit: the same is true for label-value.

@constantinpape
Copy link
Contributor Author

Slightly related minor point:
The text in https://ngff.openmicroscopy.org/latest/#label-md does not mention version, but the example json contains it.

@sbesson
Copy link
Member

sbesson commented Mar 17, 2022

My assumption is that it's historical and according to #70, if there was a change it should rather be imageLabel , imageValue .

This raises the question of how we want to review the keys introduced before the naming convention. Either supporting the legacy name and the new name for a while or making a clear breaking change both have merits

@constantinpape
Copy link
Contributor Author

constantinpape commented Mar 17, 2022

My assumption is that it's historical and according to #70, if there was a change it should rather be imageLabel , imageValue .

You're right, we decided to go for camelCase. So indeed it should be imageLabel and imageValue.

This raises the question of how we want to review the keys introduced before the naming convention. Either supporting the legacy name and the new name for a while or making a clear breaking change both have merits

My vote would be for a clear breaking change (which of course would mean a minor version bump).
But again, I don't have very strong opinions on this since I'm not the one who'd need to change the code for this ;).

@constantinpape constantinpape changed the title "image-label" not snake case "image-label" not camel case Mar 17, 2022
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

No branches or pull requests

2 participants