From e63e6821e0cfe7dffe1f3428362b7553c590bbea Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 22 May 2022 17:11:30 +0200 Subject: [PATCH] Updated Destination docstrings --- RNS/Destination.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/RNS/Destination.py b/RNS/Destination.py index 76503f1..7ea5478 100755 --- a/RNS/Destination.py +++ b/RNS/Destination.py @@ -209,7 +209,7 @@ class Destination: Registers a function to be called when a link has been established to this destination. - :param callback: A function or method to be called. + :param callback: A function or method with the signature *callback(link)* to be called when a new link is established with this destination. """ self.callbacks.link_established = callback @@ -218,7 +218,7 @@ class Destination: Registers a function to be called when a packet has been received by this destination. - :param callback: A function or method to be called. + :param callback: A function or method with the signature *callback(data, packet)* to be called when this destination receives a packet. """ self.callbacks.packet = callback @@ -228,7 +228,7 @@ class Destination: a packet sent to this destination. Allows control over when and if proofs should be returned for received packets. - :param callback: A function or method to be called. The callback must return one of True or False. If the callback returns True, a proof will be sent. If it returns False, a proof will not be sent. + :param callback: A function or method to with the signature *callback(packet)* be called when a packet that requests a proof is received. The callback must return one of True or False. If the callback returns True, a proof will be sent. If it returns False, a proof will not be sent. """ self.callbacks.proof_requested = callback