Skip to content

Commit

Permalink
very small documentation improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
Syndace committed Apr 5, 2020
1 parent 333df16 commit ee5737e
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions x3dh/state.py
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,11 @@ def _encode_public_key(self, curve: Curve, key_type: CurveType, pub: bytes) -> b
An encoding of the public key, possibly including information about the curve and type of key,
though this is application defined. Note that two different public keys must never result in the
same byte sequence, uniqueness of the public keys must be preserved.
Note:
This method is called from :meth:`create`, before :meth:`create` has returned the instance. Thus,
modifications to the object (``self``, in case of subclasses) may not have happened when this
method is called.
"""

raise NotImplementedError("Create a subclass of X3DH and implement `_encode_public_key`.")
Expand Down

0 comments on commit ee5737e

Please sign in to comment.