Use ChunkKeyEncodingLike type alias#2763
Conversation
|
@dstansby can you check that my release notes are correct? and is it possible for the gha that adds the |
|
Looks good to me! Perhaps the note could say how the change impacts users? I'm guessing here the typing is just being made more permissive?
Yes, it looks like there's a |
|
It should have no effect on users. |
|
In that case I'd probably skip adding a release note? At least in my mind, release notes are targeted other folks using the package, not internally for developers. |
|
developers are also users :) |
|
in fact, I think developers will be more interested in reading the release notes than ordinary users. Thus I don't see a particular reason to omit infrastructure changes from the release notes. |
|
I guess so - in that case LGTM, and perhaps the 'chore' release notes category is a good place to put developer facing notes 👍 |
previously,
ChunkKeyEncodingLikewas the name of aTypedDictinstance that models the JSON form of thechunk_key_encodingattribute in zarr v3 array metadata. ButChunkKeyEncodingLikeshould be the name of a type alias that denotes the union of types that can be converted to an instance ofChunkKeyEncoding. So I renamed the typeddict toChunkKeyEncodingParamsand added a type alias (it isChunkKeyEncoding | ChunkKeyEncodingParams)