Skip to content

Commit 8217c7f

Browse files
committed
Add chunksizes docstring
1 parent 7166cc9 commit 8217c7f

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

fractal_tasks_core/__FRACTAL_MANIFEST__.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,7 @@
202202
"args_schema_parallel": {
203203
"$defs": {
204204
"ChunkSizes": {
205+
"description": "Chunk size settings for OME-Zarrs. ",
205206
"properties": {
206207
"t": {
207208
"title": "T",
@@ -227,8 +228,7 @@
227228
}
228229
},
229230
"title": "ChunkSizes",
230-
"type": "object",
231-
"description": "Missing description for ChunkSizes."
231+
"type": "object"
232232
},
233233
"InitArgsCellVoyager": {
234234
"description": "Arguments to be passed from cellvoyager converter init to compute",
@@ -524,6 +524,7 @@
524524
"args_schema_parallel": {
525525
"$defs": {
526526
"ChunkSizes": {
527+
"description": "Chunk size settings for OME-Zarrs. ",
527528
"properties": {
528529
"t": {
529530
"title": "T",
@@ -549,8 +550,7 @@
549550
}
550551
},
551552
"title": "ChunkSizes",
552-
"type": "object",
553-
"description": "Missing description for ChunkSizes."
553+
"type": "object"
554554
},
555555
"InitArgsCellVoyager": {
556556
"description": "Arguments to be passed from cellvoyager converter init to compute",

fractal_tasks_core/tasks/io_models.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,17 @@ def channel_is_present(self: Self) -> Self:
188188

189189

190190
class ChunkSizes(BaseModel):
191+
"""
192+
Chunk size settings for OME-Zarrs.
193+
194+
Attributes:
195+
t: Chunk size of time axis.
196+
c: Chunk size of channel axis.
197+
z: Chunk size of Z axis.
198+
y: Chunk size of y axis.
199+
x: Chunk size of x axis.
200+
"""
201+
191202
t: Optional[int] = None
192203
c: Optional[int] = 1
193204
z: Optional[int] = 10

0 commit comments

Comments
 (0)