Skip to content

Commit ad0c453

Browse files
committed
doc: document attribute types
Drop some redundant description text. Don't document the types of the standard OpenSlide property names, since they're all strings and would clutter the list. Signed-off-by: Benjamin Gilbert <[email protected]>
1 parent eb5bd08 commit ad0c453

File tree

1 file changed

+25
-5
lines changed

1 file changed

+25
-5
lines changed

doc/index.rst

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -126,27 +126,36 @@ OpenSlide objects
126126
The number of levels in the slide. Levels are numbered from ``0``
127127
(highest resolution) to ``level_count - 1`` (lowest resolution).
128128

129+
:type: int
130+
129131
.. attribute:: dimensions
130132

131133
A ``(width, height)`` tuple for level 0 of the slide.
132134

135+
:type: tuple[int, int]
136+
133137
.. attribute:: level_dimensions
134138

135139
A tuple of ``(width, height)`` tuples, one for each level of the slide.
136140
``level_dimensions[k]`` are the dimensions of level ``k``.
137141

142+
:type: tuple[tuple[int, int], ...]
143+
138144
.. attribute:: level_downsamples
139145

140146
A tuple of downsample factors for each level of the slide.
141147
``level_downsamples[k]`` is the downsample factor of level ``k``.
142148

149+
:type: tuple[float, ...]
150+
143151
.. attribute:: properties
144152

145153
Metadata about the slide, in the form of a
146154
:class:`~collections.abc.Mapping` from OpenSlide property name to
147-
property value. Property values are always strings. OpenSlide
148-
provides some :ref:`standard-properties`, plus
149-
additional properties that vary by slide format.
155+
property value. OpenSlide provides some :ref:`standard-properties`,
156+
plus additional properties that vary by slide format.
157+
158+
:type: ~collections.abc.Mapping[str, str]
150159

151160
.. attribute:: associated_images
152161

@@ -156,11 +165,14 @@ OpenSlide objects
156165

157166
Unlike in the C interface, these images are not premultiplied.
158167

168+
:type: ~collections.abc.Mapping[str, ~PIL.Image.Image]
169+
159170
.. attribute:: color_profile
160171

161172
The embedded :ref:`color profile <color-management>` for this slide,
162-
as a Pillow :class:`~PIL.ImageCms.ImageCmsProfile`, or :obj:`None` if
163-
not available.
173+
or :obj:`None` if not available.
174+
175+
:type: ~PIL.ImageCms.ImageCmsProfile | None
164176

165177
.. method:: read_region(location, level, size)
166178

@@ -403,20 +415,28 @@ Deep Zoom or a similar format.
403415

404416
The number of Deep Zoom levels in the image.
405417

418+
:type: int
419+
406420
.. attribute:: tile_count
407421

408422
The total number of Deep Zoom tiles in the image.
409423

424+
:type: int
425+
410426
.. attribute:: level_tiles
411427

412428
A tuple of ``(tiles_x, tiles_y)`` tuples for each Deep Zoom level.
413429
``level_tiles[k]`` are the tile counts of level ``k``.
414430

431+
:type: tuple[tuple[int, int], ...]
432+
415433
.. attribute:: level_dimensions
416434

417435
A tuple of ``(pixels_x, pixels_y)`` tuples for each Deep Zoom level.
418436
``level_dimensions[k]`` are the dimensions of level ``k``.
419437

438+
:type: tuple[tuple[int, int], ...]
439+
420440
.. method:: get_dzi(format)
421441

422442
Return a string containing the XML metadata for the Deep Zoom ``.dzi``

0 commit comments

Comments
 (0)