Skip to content

Commit 8bc2c8c

Browse files
fixup: chilldkg: add API docs for blaming functions
1 parent 5d4dc0f commit 8bc2c8c

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

python/chilldkg_ref/chilldkg.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -597,7 +597,7 @@ def participant_investigate(
597597
598598
This function can optionally be called when `participant_step2` raises
599599
`UnknownFaultyParticipantOrCoordinatorError`. It narrows down the suspected
600-
faulty parties by analyzing the blame message provided by the coordinator.
600+
faulty parties by analyzing the investigation message provided by the coordinator.
601601
602602
This function does not return normally. Instead, it raises one of two
603603
exceptions.
@@ -606,7 +606,7 @@ def participant_investigate(
606606
error: `UnknownFaultyParticipantOrCoordinatorError` raised by
607607
`participant_step2`.
608608
cinv: Coordinator investigation message for this participant as output
609-
by `coordinator_blame`.
609+
by `coordinator_investigate`.
610610
611611
Raises:
612612
FaultyParticipantOrCoordinatorError: If another known participant or the
@@ -736,7 +736,7 @@ def coordinator_investigate(
736736
pmsgs: List of first messages received from the participants.
737737
738738
Returns:
739-
List[CoordinatorInvestigationMsg]: A list of blame messages, each
739+
List[CoordinatorInvestigationMsg]: A list of investigation messages, each
740740
intended for a single participant.
741741
"""
742742
enc_cinvs = encpedpop.coordinator_investigate([pmsg.enc_pmsg for pmsg in pmsgs])

0 commit comments

Comments
 (0)