Skip to content

Commit

Permalink
docs: fix getroute manpage rendering
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
wythe authored and niftynei committed Jan 23, 2019
1 parent 17b9693 commit 287af7b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 11 deletions.
8 changes: 4 additions & 4 deletions doc/lightning-getroute.7
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: lightning-getroute
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" 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
.\" -----------------------------------------------------------------
Expand Down Expand Up @@ -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 <rusty@rustcorp\&.com\&.au> is mainly responsible\&.
Expand Down
15 changes: 8 additions & 7 deletions doc/lightning-getroute.7.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 287af7b

Please sign in to comment.