Skip to content
This repository was archived by the owner on Apr 19, 2024. It is now read-only.

Commit 293fb1d

Browse files
committed
begin module-level docstring
1 parent 49bce75 commit 293fb1d

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

multihash.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,24 @@
33
# Initial author: Ivan Vilata-i-Balaguer
44
# License: MIT
55

6+
"""Python implementation of the multihash specification
7+
8+
This is an implementation of the `multihash`_ specification in Python.
9+
The main component in the module is the `Multihash` class, a named tuple that
10+
represents a hash function and a digest created with it, with extended
11+
abilities to work with hashlib-compatible hash functions, verify the integrity
12+
of data, and encode itself to a byte string in the binary format described in
13+
the specification. The `decode()` function can be used for the inverse
14+
operation, i.e. converting a byte string into a `Multihash` object.
15+
16+
.. functions
17+
18+
.. codecs
19+
20+
.. _multihash: https://github.com/jbenet/multihash
21+
22+
"""
23+
624
from collections import namedtuple
725
from enum import Enum
826
from numbers import Integral

0 commit comments

Comments
 (0)