Skip to content

Commit a3cefd2

Browse files
committed
Fix doc
1 parent 6d9512d commit a3cefd2

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

blosc2/utils.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ def pack(obj, clevel=9, shuffle=blosc2_ext.SHUFFLE, cname='blosclz'):
169169
The name of the compressor used internally in Blosc. It can be
170170
any of the supported by Blosc (`blosclz`, `lz4`, `lz4hc`,
171171
`zlib`, `zstd` and maybe others too). The default is
172-
'blosclz'.
172+
`blosclz`.
173173
174174
Returns
175175
-------
@@ -179,8 +179,8 @@ def pack(obj, clevel=9, shuffle=blosc2_ext.SHUFFLE, cname='blosclz'):
179179
Raises
180180
------
181181
AttributeError
182-
If the object does not have an 'itemsize' attribute.
183-
If the object does not have an 'size' attribute.
182+
If the object does not have an `itemsize` attribute.
183+
If the object does not have an `size` attribute.
184184
ValueError
185185
If obj.itemsize * obj.size is larger than the maximum allowed buffer size.
186186
If typesize is not within the allowed range.
@@ -273,9 +273,9 @@ def pack_array(arr, clevel=9, shuffle=blosc2_ext.SHUFFLE, cname='blosclz'):
273273
default is blosc.SHUFFLE.
274274
cname : string (optional)
275275
The name of the compressor used internally in Blosc. It can be
276-
any of the supported by Blosc ('blosclz', 'lz4', 'lz4hc',
277-
'zlib', 'zstd' and maybe others too). The default is
278-
'blosclz'.
276+
any of the supported by Blosc (`blosclz`, `lz4`, `lz4hc`,
277+
`zlib`, `zstd` and maybe others too). The default is
278+
`blosclz`.
279279
280280
Returns
281281
-------
@@ -285,7 +285,7 @@ def pack_array(arr, clevel=9, shuffle=blosc2_ext.SHUFFLE, cname='blosclz'):
285285
Raises
286286
------
287287
AttributeError
288-
If the object does not have an 'itemsize' attribute.
288+
If the object does not have an `itemsize` attribute.
289289
ValueError
290290
If array.itemsize * array.size is larger than the maximum allowed buffer size.
291291
If typesize is not within the allowed range.
@@ -357,9 +357,9 @@ def unpack_array(packed_array, **kwargs):
357357

358358

359359
def set_compressor(compname):
360-
"""Set the compressor to be used. The supported ones are "blosclz",
361-
"lz4", "lz4hc", "zlib" and "ztsd". If this function is not
362-
called, then "blosclz" will be used.
360+
"""Set the compressor to be used. The supported ones are `blosclz`,
361+
`lz4`, `lz4hc`, `zlib` and `ztsd`. If this function is not
362+
called, then `blosclz` will be used.
363363
364364
Parameters
365365
----------

0 commit comments

Comments
 (0)