Repository navigation
Conversation
Automated Review URLs |
|
Pinging @joshmoore for RFC number. |
lubianat
left a comment
There was a problem hiding this comment.
looks well formatted afaik! thank you!
|
A general comment here is that for new RFCs, we need to wait for Editorial Board (@joshmoore or @vuhlmann) to give an official "ok" before we can merge the PR |
Co-authored-by: Tiago Lubiana <[email protected]>
DragaDoncila
left a comment
There was a problem hiding this comment.
Finally got around to finishing this read-through, apologies for the delay @normanrz.
All good to go on my end, minor tweaks can be ignored. Left one comment about extension-defined type values also not matching the identifier regex but can be addressed in follow-up.
| } | ||
| ``` | ||
|
|
||
| Zarr codec and extension names follow the same style, e.g. `sharding_indexed`, `index_codecs` and `index_location`. |
There was a problem hiding this comment.
| Zarr codec and extension names follow the same style, e.g. `sharding_indexed`, `index_codecs` and `index_location`. | |
| Zarr codec and extension names also follow the same style, e.g. `sharding_indexed`, `index_codecs` and `index_location`. |
| ``` | ||
|
|
||
| Zarr codec and extension names follow the same style, e.g. `sharding_indexed`, `index_codecs` and `index_location`. | ||
| A group's `zarr.json` with OME-Zarr metadata therefore mixes `zarr_format` and `node_type` with `coordinateTransformations` and `coordinateSystems` in the same JSON object tree. |
There was a problem hiding this comment.
| A group's `zarr.json` with OME-Zarr metadata therefore mixes `zarr_format` and `node_type` with `coordinateTransformations` and `coordinateSystems` in the same JSON object tree. | |
| An OME-Zarr file's `zarr.json` therefore mixes Zarr identifiers like `zarr_format` and `node_type` with OME-Zarr identifiers like `coordinateTransformations` and `coordinateSystems` in the same JSON object tree. |
|
|
||
| ### The OME-Zarr metadata is not consistent with itself | ||
|
|
||
| Within the OME-Zarr metadata itself, multi-word keys use several styles side by side: `camelCase` (e.g. `coordinateTransformations`), `snake_case` (e.g. `field_count`), run-together lowercase (e.g. `maximumfieldcount`), `kebab-case` (e.g. `label-value`) and dotted names (e.g. `bioformats2raw.layout`). |
There was a problem hiding this comment.
| Within the OME-Zarr metadata itself, multi-word keys use several styles side by side: `camelCase` (e.g. `coordinateTransformations`), `snake_case` (e.g. `field_count`), run-together lowercase (e.g. `maximumfieldcount`), `kebab-case` (e.g. `label-value`) and dotted names (e.g. `bioformats2raw.layout`). | |
| Within the OME-Zarr metadata itself, multi-word keys use several styles side-by-side: `camelCase` (e.g. `coordinateTransformations`), `snake_case` (e.g. `field_count`), run-together lowercase (e.g. `maximumfieldcount`), `kebab-case` (e.g. `label-value`) and dotted names (e.g. `bioformats2raw.layout`). |
|
|
||
| The specification has also moved in both directions. | ||
| Version 0.6 renamed the `byDimension` fields `input_axes` and `output_axes` to `inputAxes` and `outputAxes`, to be consistent with the other transformations. | ||
| A rule that holds for the whole document, including the Zarr part, would end this kind of churn. |
There was a problem hiding this comment.
| A rule that holds for the whole document, including the Zarr part, would end this kind of churn. | |
| A rule that holds for the whole document, including the Zarr part, together with a pre-1.0 comprehensive renaming, would end this kind of churn. |
|
|
||
| ## Proposal | ||
|
|
||
| 1. All multi-word keys in the OME-Zarr metadata MUST be written in `snake_case`: lowercase ASCII letters and digits, with words separated by a single underscore, i.e. matching `^[a-z][a-z0-9]*(_[a-z0-9]+)*$`. |
There was a problem hiding this comment.
| 1. All multi-word keys in the OME-Zarr metadata MUST be written in `snake_case`: lowercase ASCII letters and digits, with words separated by a single underscore, i.e. matching `^[a-z][a-z0-9]*(_[a-z0-9]+)*$`. | |
| 1. All OME-Zarr metadata multi-word keys under the `ome` key in a `zarr.json` MUST be written in `snake_case`: lowercase ASCII letters and digits, with words separated by a single underscore, i.e. matching `^[a-z][a-z0-9]*(_[a-z0-9]+)*$`. |
| ## Proposal | ||
|
|
||
| 1. All multi-word keys in the OME-Zarr metadata MUST be written in `snake_case`: lowercase ASCII letters and digits, with words separated by a single underscore, i.e. matching `^[a-z][a-z0-9]*(_[a-z0-9]+)*$`. | ||
| 2. The same rule applies to identifiers that the specification defines as values of discriminator fields, e.g. transformation `type` values. |
There was a problem hiding this comment.
Excepting extension-defined custom types also right? Maybe worth mentioning that here or under "Not renamed"?
This PR adds an RFC for switching the metadata field names to snake_case (consistently).
cc @DragaDoncila