Skip to content

Commit 717dd62

Browse files
committed
edit docstrings
1 parent 08d96a7 commit 717dd62

File tree

2 files changed

+5
-9
lines changed

2 files changed

+5
-9
lines changed

numcodecs/msgpacks.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,7 @@
1010

1111

1212
class MsgPack(Codec):
13-
"""Codec to encode data as msgpacked bytes. Useful for encoding an array of Python strings
14-
15-
Raises
16-
------
17-
encoding a non-object dtyped ndarray will raise ValueError
13+
"""Codec to encode data as msgpacked bytes. Useful for encoding an array of Python strings.
1814
1915
Examples
2016
--------
@@ -29,6 +25,10 @@ class MsgPack(Codec):
2925
--------
3026
:class:`numcodecs.pickles.Pickle`
3127
28+
Notes
29+
-----
30+
Requires `msgpack-python <https://pypi.python.org/pypi/msgpack-python>`_ to be installed.
31+
3232
""" # flake8: noqa
3333

3434
codec_id = 'msgpack'

numcodecs/pickles.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,6 @@ class Pickle(Codec):
2121
protocol : int, defaults to pickle.HIGHEST_PROTOCOL
2222
The protocol used to pickle data.
2323
24-
Raises
25-
------
26-
Encoding a non-object dtyped ndarray will raise ValueError.
27-
2824
Examples
2925
--------
3026
>>> import numcodecs as codecs

0 commit comments

Comments
 (0)