From 68ca903db4f03aa8aa2c3f08481b2c36f15a58e0 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Tue, 8 Apr 2025 14:02:10 +0200 Subject: [PATCH] Updated Identity API docstring --- RNS/Identity.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/RNS/Identity.py b/RNS/Identity.py index 382241b..5c39b2a 100644 --- a/RNS/Identity.py +++ b/RNS/Identity.py @@ -95,7 +95,12 @@ class Identity: @staticmethod def recall(target_hash, from_identity_hash=False): """ - Recall identity for a destination or identity hash. + Recall identity for a destination or identity hash. By default, this function + will return the identity associated with a given *destination* hash. As an + example, if you know the ``lxmf.delivery`` destination hash of an endpoint, + this function will return the associated underlying identity. You can also + search for an identity from a known *identity hash*, by setting the + ``from_identity_hash`` argument. :param target_hash: Destination or identity hash as *bytes*. :param from_identity_hash: Whether to search based on identity hash instead of destination hash as *bool*.