From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Sat, 30 Jan 2021 00:04:00 +0000 (+0000)
Subject: updates, errors: Add a doc comment
X-Git-Tag: otter-0.4.0~645
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=d922f8e77d012f749fc1fdfffdcbdfe4598b5444;p=otter.git

updates, errors: Add a doc comment

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---

diff --git a/src/error.rs b/src/error.rs
index 22d9f97e..04e4978f 100644
--- a/src/error.rs
+++ b/src/error.rs
@@ -79,6 +79,12 @@ impl From<InternalError> for SpecError {
 pub enum ApiPieceOpError {
   ReportViaResponse(#[from] OnlineError),
   ReportViaUpdate(#[from] PieceOpError),
+
+  /// This error is always generated in the context of a piece
+  /// operation by a particular client.  It corresponds roughly to a
+  /// PieceUpdateFromOp for other clients of (Unpredicable,
+  /// PieceUpdateOp::Modify, ..).
+  /// For this client it is that but also an error report.
   PartiallyProcessed(PieceOpError, Vec<LogEntry>),
 }
 display_as_debug!(ApiPieceOpError);