From 8bc2c8ced0f3dda0ecf5001519a52c564ea7cd1d Mon Sep 17 00:00:00 2001 From: Tim Ruffing Date: Wed, 18 Dec 2024 23:32:43 +0100 Subject: [PATCH] fixup: chilldkg: add API docs for blaming functions --- python/chilldkg_ref/chilldkg.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/python/chilldkg_ref/chilldkg.py b/python/chilldkg_ref/chilldkg.py index 714e50d..b9bfef9 100644 --- a/python/chilldkg_ref/chilldkg.py +++ b/python/chilldkg_ref/chilldkg.py @@ -597,7 +597,7 @@ def participant_investigate( This function can optionally be called when `participant_step2` raises `UnknownFaultyParticipantOrCoordinatorError`. It narrows down the suspected - faulty parties by analyzing the blame message provided by the coordinator. + faulty parties by analyzing the investigation message provided by the coordinator. This function does not return normally. Instead, it raises one of two exceptions. @@ -606,7 +606,7 @@ def participant_investigate( error: `UnknownFaultyParticipantOrCoordinatorError` raised by `participant_step2`. cinv: Coordinator investigation message for this participant as output - by `coordinator_blame`. + by `coordinator_investigate`. Raises: FaultyParticipantOrCoordinatorError: If another known participant or the @@ -736,7 +736,7 @@ def coordinator_investigate( pmsgs: List of first messages received from the participants. Returns: - List[CoordinatorInvestigationMsg]: A list of blame messages, each + List[CoordinatorInvestigationMsg]: A list of investigation messages, each intended for a single participant. """ enc_cinvs = encpedpop.coordinator_investigate([pmsg.enc_pmsg for pmsg in pmsgs])