docs: fix the docstring for CodecPipeline.write (#3836)

d-v-b · web-flow · commit 8ca385ac9c62 · 2026-03-26T10:39:39.000+01:00
* Fix the docstring for `CodecPipeline.write`

The annotation for the `batch_info` parameter in `CodecPipeline.write` omits the final bool from the tuple. This
PR corrects the type annotation in the docstring.

* docs: changelog

* docs: rename changelog file
diff --git a/changes/3836.doc.md b/changes/3836.doc.md
@@ -0,0 +1,2 @@
+Corrects the type annotation reported for the `batch_info` parameter in the `CodecPipeline.write`
+method docstring.
diff --git a/src/zarr/abc/codec.py b/src/zarr/abc/codec.py
@@ -480,7 +480,7 @@ async def write(
 
         Parameters
         ----------
-        batch_info : Iterable[tuple[ByteSetter, ArraySpec, SelectorTuple, SelectorTuple]]
+        batch_info : Iterable[tuple[ByteSetter, ArraySpec, SelectorTuple, SelectorTuple, bool]]
             Ordered set of information about the chunks.
             The first slice selection determines which parts of the chunk will be encoded.
             The second slice selection determines where in the value array the chunk data is located.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+Corrects the type annotation reported for the `batch_info` parameter in the `CodecPipeline.write`
	`2`	`+method docstring.`