Rename internal snake_case identifiers to camelCase#387
Merged
Conversation
🦋 Changeset detectedLatest commit: 6020ad4 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
The codebase inherited Python-style snake_case naming from zarr-python,
which created confusion about what is a zarr metadata field versus an
internal API. This change draws a clear boundary: zarr metadata types
(`ArrayMetadata`, `GroupMetadata`, `CodecMetadata`, etc.) retain
snake_case because they represent the on-disk JSON format, while all
internal function names, variable names, and interface properties use
idiomatic TypeScript camelCase.
The most visible breaking change is `CreateArrayOptions`, whose
properties move to camelCase:
await zarr.create(store, {
shape: [100, 100],
chunkShape: [10, 10], // was chunk_shape
dataType: "float32", // was data_type
fillValue: 0, // was fill_value
})
Internal exports consumed by `@zarrita/ndarray` are also renamed
(`_zarrita_internal_getStrides`, `_zarrita_internal_sliceIndices`), and
the `Setter` type properties become `setScalar`/`setFromChunk`.
CreateArrayOptions properties are now camelCase (chunkShape, fillValue, chunkSeparator, dimensionNames). Array getters keep dtype and chunks to match zarr-python.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The codebase inherited Python-style snake_case naming from zarr-python, which created confusion about what is a zarr metadata field versus an internal API. This change draws a clear boundary: zarr metadata types (
ArrayMetadata,GroupMetadata,CodecMetadata, etc.) retain snake_case because they represent the on-disk JSON format, while all internal function names, variable names, and interface properties use idiomatic TypeScript camelCase.The most visible breaking change is
CreateArrayOptions, whose properties move to camelCase:Internal exports consumed by
@zarrita/ndarrayare also renamed (_zarrita_internal_getStrides,_zarrita_internal_sliceIndices), and theSettertype properties becomesetScalar/setFromChunk.Also closes #217