From fa5e0452e875a7ca6bf6fe61fdd652d341eece40 Mon Sep 17 00:00:00 2001
From: MarcoFalke <falke.marco@gmail.com>
Date: Thu, 15 Nov 2018 12:19:41 -0500
Subject: [PATCH] rpc: Documentation fixups

---
 src/rpc/misc.cpp           | 2 +-
 test/lint/lint-rpc-help.sh | 7 +++++++
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/src/rpc/misc.cpp b/src/rpc/misc.cpp
index a6c90bd6d73..5543035885b 100644
--- a/src/rpc/misc.cpp
+++ b/src/rpc/misc.cpp
@@ -461,7 +461,7 @@ static UniValue echo(const JSONRPCRequest& request)
         throw std::runtime_error(
             RPCHelpMan{"echo|echojson ...",
                 "\nSimply echo back the input arguments. This command is for testing.\n"
-                "\nThe difference between echo and echojson is that echojson has argument conversion enabled in the client-side table in"
+                "\nThe difference between echo and echojson is that echojson has argument conversion enabled in the client-side table in "
                 "bitcoin-cli and the GUI. There is no server-side difference.",
                 {}}
                 .ToString() +
diff --git a/test/lint/lint-rpc-help.sh b/test/lint/lint-rpc-help.sh
index 602396745f2..faac5d43e2e 100755
--- a/test/lint/lint-rpc-help.sh
+++ b/test/lint/lint-rpc-help.sh
@@ -3,10 +3,17 @@
 # Copyright (c) 2018 The Bitcoin Core developers
 # Distributed under the MIT software license, see the accompanying
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
+#
+# Check that all RPC help texts are generated by RPCHelpMan.
 
 export LC_ALL=C
 
 EXIT_CODE=0
+
+# Assume that all multiline strings passed into a runtime_error are help texts.
+# This is potentially fragile, but the linter is only temporary and can safely
+# be removed early 2019.
+
 non_autogenerated_help=$(grep --perl-regexp --null-data --only-matching 'runtime_error\(\n\s*".*\\n"\n' $(git ls-files -- "*.cpp"))
 if [[ ${non_autogenerated_help} != "" ]]; then
     echo "Must use RPCHelpMan to generate the help for the following RPC methods:"