mirror of
https://github.com/aljazceru/python-teos.git
synced 2026-02-03 13:44:29 +01:00
plugin - Adds docstrings
This commit is contained in:
@@ -27,8 +27,8 @@ def generate_keys(data_dir):
|
||||
data_dir (:obj:`str`): path to data directory where the keys will be stored.
|
||||
|
||||
Returns:
|
||||
:obj:`tuple`: a tuple containing a ``PrivateKey`` and a ``str`` representing the client sk and
|
||||
compressed pk respectively.
|
||||
:obj:`tuple`: a tuple containing a ``PrivateKey`` and a ``str`` representing the client sk and compressed pk
|
||||
respectively.
|
||||
|
||||
Raises:
|
||||
:obj:`FileExistsError`: if the key pair already exists in the given directory.
|
||||
@@ -56,8 +56,8 @@ def load_keys(data_dir):
|
||||
data_dir (:obj:`str`): path to data directory where the keys are stored.
|
||||
|
||||
Returns:
|
||||
:obj:`tuple`: a tuple containing a ``EllipticCurvePrivateKey`` and a ``str`` representing the client sk and
|
||||
compressed pk respectively.
|
||||
:obj:`tuple`: a tuple containing a ``PrivateKey`` and a ``str`` representing the client sk and compressed pk
|
||||
respectively.
|
||||
|
||||
Raises:
|
||||
:obj:`InvalidKey <cli.exceptions.InvalidKey>`: if any of the keys is invalid or cannot be loaded.
|
||||
|
||||
Reference in New Issue
Block a user