From 12a5498a6e749e24f155a3dcda22ec0855eeb193 Mon Sep 17 00:00:00 2001
From: Christian Grothoff <christian@grothoff.org>
Date: Tue, 4 Feb 2020 20:59:17 +0100
Subject: use hint, not error

---
 core/api-common.rst | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

(limited to 'core/api-common.rst')

diff --git a/core/api-common.rst b/core/api-common.rst
index 2ea5459e..689e8065 100644
--- a/core/api-common.rst
+++ b/core/api-common.rst
@@ -73,9 +73,7 @@ handle the error as if an internal error (500) had been returned.
 
       // Human-readable description of the error, i.e. "missing parameter", "commitment violation", ...
       // The other arguments are specific to the error value reported here.
-      error: string;
-
-      // Hint about error nature
+      // Should give a human-readable hint about the error's nature. Optional.
       hint?: string;
 
       // Name of the parameter that was bogus (if applicable)
-- 
cgit v1.2.3