Skip to content

Commit

Permalink
doc: add documentation to storage ABC
Browse files Browse the repository at this point in the history
  • Loading branch information
rezamahdi committed Feb 24, 2022
1 parent e95f74d commit bf20346
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions src/pyzantium/storage/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,12 @@ class Storage(ABC):
All storage mechanisms must implement this base class.
This class provides an abstraction to separate storage from higher level
blockchain machinary.
blockchain machinary. Note that objects of ``Storage``'s subclass
is not intended to be used directly by user.
:param name: Name of storage. This name is not name of blockchain it is
just a name for storage class.
:type name: str
"""

def __init__(self, name: str) -> None:
Expand All @@ -33,4 +38,5 @@ def __next__(self):
def __len__(self) -> int:
...

from .disk import DiskStorage

from .disk import DiskStorage

0 comments on commit bf20346

Please sign in to comment.