From 287af7b66018ba880f3272f85d70c3fbb9536517 Mon Sep 17 00:00:00 2001 From: Mark Beckwith Date: Wed, 23 Jan 2019 10:39:56 -0600 Subject: [PATCH] docs: fix getroute manpage rendering My manpage viewer did not know what to do with curly braces, so I switched them to quotes and it works fine. Signed-off-by: Mark Beckwith --- doc/lightning-getroute.7 | 8 ++++---- doc/lightning-getroute.7.txt | 15 ++++++++------- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/doc/lightning-getroute.7 b/doc/lightning-getroute.7 index 69658de21..af94a0aa3 100644 --- a/doc/lightning-getroute.7 +++ b/doc/lightning-getroute.7 @@ -2,12 +2,12 @@ .\" Title: lightning-getroute .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/17/2018 +.\" Date: 01/23/2019 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "LIGHTNING\-GETROUTE" "7" "12/17/2018" "\ \&" "\ \&" +.TH "LIGHTNING\-GETROUTE" "7" "01/23/2019" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -257,9 +257,9 @@ T} 1000 is an aggressive value for trying to minimize timeouts at all costs\&. .SH "RETURN VALUE" .sp -On success, a "route" array is returned\&. Each array element contains +On success, a "route" array is returned\&. Each array element contains \fIid\fR (the node being routed through), \fImsatoshi\fR (the millisatoshis sent), and \fIdelay\fR (the number of blocks to timeout at this node)\&. .sp -timeout for the payment failure, in blocks\&. +The final \fIid\fR will be the destination \fIid\fR given in the input\&. The difference between the first \fImsatoshi\fR minus the \fImsatoshi\fR given in the input is the fee\&. The first \fIdelay\fR is the very worst case timeout for the payment failure, in blocks\&. .SH "AUTHOR" .sp Rusty Russell is mainly responsible\&. diff --git a/doc/lightning-getroute.7.txt b/doc/lightning-getroute.7.txt index 53a3f674f..388072f14 100644 --- a/doc/lightning-getroute.7.txt +++ b/doc/lightning-getroute.7.txt @@ -95,13 +95,14 @@ costs. RETURN VALUE ------------ -On success, a "route" array is returned. Each array element contains -{id} (the node being routed through), {msatoshi} (the millisatoshis -sent), and {delay} (the number of blocks to timeout at this node). - -The final {id} will be the destination {id} given in the input. The -difference between the first {msatoshi} minus the {msatoshi} given in -the input is the fee. The first {delay} is the very worst case +On success, a "route" array is returned. +Each array element contains 'id' (the node being routed through), 'msatoshi' +(the millisatoshis sent), and 'delay' (the number of blocks to timeout at this +node). + +The final 'id' will be the destination 'id' given in the input. The +difference between the first 'msatoshi' minus the 'msatoshi' given in +the input is the fee. The first 'delay' is the very worst case timeout for the payment failure, in blocks. //FIXME:Enumerate errors