From 513e3403d5c5d42b395e8934cb89e9971476beca Mon Sep 17 00:00:00 2001 From: Tim Ruffing Date: Wed, 27 Nov 2024 11:46:17 +0100 Subject: [PATCH] Rework and document blame exceptions --- README.md | 9 +++++---- python/chilldkg_ref/util.py | 9 +++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d92b70e..de33539 100644 --- a/README.md +++ b/README.md @@ -966,7 +966,7 @@ participant is indeed faulty. This exception is raised only by the coordinator code. Some faulty behavior by participants will be detected by the other participants instead. -See FaultyParticipantOrCoordinatorError for details. +See `FaultyParticipantOrCoordinatorError` for details. *Attributes*: @@ -996,7 +996,7 @@ participant). This exception is raised only by the participant code. Some faulty behavior by participants will be detected by the coordinator instead. See -FaultyParticipantError for details. +`FaultyParticipantError` for details. *Attributes*: @@ -1030,7 +1030,7 @@ information to determine which participant should be suspected. To determine a suspected participant, the raising participant may choose to run the optional blame step of the protocol, which requires obtaining a -blame message by the coordinator. See the participant_blame function for +blame message by the coordinator. See the `participant_blame` function for details. This is only raised for specific faulty behavior by another participant @@ -1039,7 +1039,8 @@ the coordinator (namely, sending invalid encrypted secret shares). *Attributes*: -- `blame_state` _BlameState_ - To be given to the participant_blame function. +- `blame_state` _BlameState_ - To be passed to the `participant_blame` + function. ## Changelog diff --git a/python/chilldkg_ref/util.py b/python/chilldkg_ref/util.py index 67fd2bf..0685363 100644 --- a/python/chilldkg_ref/util.py +++ b/python/chilldkg_ref/util.py @@ -34,7 +34,7 @@ class FaultyParticipantError(ProtocolError): This exception is raised only by the coordinator code. Some faulty behavior by participants will be detected by the other participants instead. - See FaultyParticipantOrCoordinatorError for details. + See `FaultyParticipantOrCoordinatorError` for details. Attributes: participant (int): Index of the faulty participant. @@ -64,7 +64,7 @@ class FaultyParticipantOrCoordinatorError(ProtocolError): This exception is raised only by the participant code. Some faulty behavior by participants will be detected by the coordinator instead. See - FaultyParticipantError for details. + `FaultyParticipantError` for details. Attributes: participant (int): Index of the suspected participant. @@ -95,7 +95,7 @@ class UnknownFaultyParticipantOrCoordinatorError(ProtocolError): To determine a suspected participant, the raising participant may choose to run the optional blame step of the protocol, which requires obtaining a - blame message by the coordinator. See the participant_blame function for + blame message by the coordinator. See the `participant_blame` function for details. This is only raised for specific faulty behavior by another participant @@ -103,7 +103,8 @@ class UnknownFaultyParticipantOrCoordinatorError(ProtocolError): the coordinator (namely, sending invalid encrypted secret shares). Attributes: - blame_state (BlameState): To be given to the participant_blame function. + blame_state (BlameState): To be passed to the `participant_blame` + function. """ def __init__(self, blame_state: Any, *args: Any):