doc: unify man pages error sections

Change all man pages to follow the style of doc/lightning-pay.7.md for the section on returning errors. Changelog-None
waldow90 · Jan 21, 2020 · 3cf91b2 · 3cf91b2
1 parent 89466f0
commit 3cf91b2
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 81 deletions.
diff --git a/doc/lightning-disconnect.7 b/doc/lightning-disconnect.7
diff --git a/doc/lightning-disconnect.7.md b/doc/lightning-disconnect.7.md
@@ -35,17 +35,11 @@ RETURN VALUE
 
 On success, an empty object is returned.
 
-ERRORS
-------
-
-If *id* is invalid, an error message will be returned:
-
-    { "code" : -1, "message" : "Peer not connected" }
-
-If the peer has an active channel and *force* is not set, an error
-message will be returned:
+On error the returned object will contain `code` and `message` properties,
+with `code` being one of the following:
 
-    { "code" : -1, "message" : "Peer is in state CHANNELD_NORMAL" }
+- -32602: If the given parameters are wrong.
+- -1: Catchall nonspecific error.
 
 AUTHOR
 ------

diff --git a/doc/lightning-listchannels.7 b/doc/lightning-listchannels.7
diff --git a/doc/lightning-listchannels.7.md b/doc/lightning-listchannels.7.md
@@ -65,16 +65,10 @@ through this channel.
 If *short\_channel\_id* or *source* is supplied and no matching channels
 are found, a "channels" object with an empty list is returned.
 
-ERRORS
-------
-
-If *short\_channel\_id* is not a valid short\_channel\_id, an error
-message will be returned:
-
-    { "code" : -32602,
-      "message" : "'short_channel_id' should be a short channel id, not '...'" }
+On error the returned object will contain `code` and `message` properties,
+with `code` being one of the following:
 
-Similarly if *source* is not a valid pubkey.
+- -32602: If the given parameters are wrong.
 
 AUTHOR
 ------

diff --git a/doc/lightning-listpeers.7 b/doc/lightning-listpeers.7
diff --git a/doc/lightning-listpeers.7.md b/doc/lightning-listpeers.7.md
@@ -53,16 +53,10 @@ peer at the specified *level*
 If *id* is supplied and no matching nodes are found, a "peers" object
 with an empty list is returned.
 
-ERRORS
-------
-
-If *id* is not a valid public key, an error message will be returned:
-
-    { "code" : -32602, "message" : "'id' should be a pubkey, not '...'" }
-
-If *level* is not a valid log level, an error message will be returned:
+On error the returned object will contain `code` and `message` properties,
+with `code` being one of the following:
 
-    { "code" : -32602, "message" : "'level' should be 'io', 'debug', 'info', or 'unusual', not '...'" }
+- -32602: If the given parameters are wrong.
 
 AUTHOR
 ------