Skip to content

Commit

Permalink
fixup: chilldkg: add API docs for blaming functions
Browse files Browse the repository at this point in the history
  • Loading branch information
real-or-random authored Dec 18, 2024
1 parent 5d4dc0f commit 8bc2c8c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions python/chilldkg_ref/chilldkg.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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])
Expand Down

0 comments on commit 8bc2c8c

Please sign in to comment.