From edea9bde73cb409f7cfb8c4e7640369c0d07c0d8 Mon Sep 17 00:00:00 2001
From: therealyingtong <yingtong@z.cash>
Date: Tue, 18 May 2021 12:26:59 +0800
Subject: [PATCH] Document incomplete point addition error handling

---
 src/circuit/gadget/ecc.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/circuit/gadget/ecc.rs b/src/circuit/gadget/ecc.rs
index 6351d6b4..50ba31dd 100644
--- a/src/circuit/gadget/ecc.rs
+++ b/src/circuit/gadget/ecc.rs
@@ -88,6 +88,8 @@ pub trait EccInstructions<C: CurveAffine>: Chip<C::Base> {
     ) -> Result<Self::FixedPointShort, Error>;
 
     /// Performs incomplete point addition, returning `a + b`.
+    ///
+    /// This returns an error in exceptional cases.
     fn add_incomplete(
         &self,
         layouter: &mut impl Layouter<C::Base>,