From 0b01a8c76f7f8542065d37ed7640f3ff0c73cc9d Mon Sep 17 00:00:00 2001 From: Rusty Russell Date: Mon, 31 May 2021 12:09:27 +0930 Subject: [PATCH] doc: document ordering of listpays/listsendpays. Signed-off-by: Rusty Russell --- doc/lightning-listpays.7 | 5 ++++- doc/lightning-listpays.7.md | 2 ++ doc/lightning-listsendpays.7 | 4 ++-- doc/lightning-listsendpays.7.md | 2 +- 4 files changed, 9 insertions(+), 4 deletions(-) diff --git a/doc/lightning-listpays.7 b/doc/lightning-listpays.7 index 0d2c828a1..672918f16 100644 --- a/doc/lightning-listpays.7 +++ b/doc/lightning-listpays.7 @@ -59,6 +59,9 @@ If \fBstatus\fR is "failed": \fBerroronion\fR (hex, optional): the error onion returned on failure, if any\. .RE + +The returned array is ordered by increasing \fBcreated_at\fR fields\. + .SH AUTHOR Rusty Russell \fI is mainly responsible\. @@ -71,4 +74,4 @@ Rusty Russell \fI is mainly responsible\. Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -\" SHA256STAMP:e27d57394bef9bdaf9b99ae0d9050c9044c194ab66f6c94c43b532a86e1a0031 +\" SHA256STAMP:4037a4dd9746b5dfc91ef2f5b4fa9000a334689157d9ac86dc4dba5c82628cfe diff --git a/doc/lightning-listpays.7.md b/doc/lightning-listpays.7.md index 0ade89123..aab53b6c0 100644 --- a/doc/lightning-listpays.7.md +++ b/doc/lightning-listpays.7.md @@ -37,6 +37,8 @@ If **status** is "failed": - **erroronion** (hex, optional): the error onion returned on failure, if any. [comment]: # (GENERATE-FROM-SCHEMA-END) +The returned array is ordered by increasing **created_at** fields. + AUTHOR ------ diff --git a/doc/lightning-listsendpays.7 b/doc/lightning-listsendpays.7 index 5cb045fff..8f594c82c 100644 --- a/doc/lightning-listsendpays.7 +++ b/doc/lightning-listsendpays.7 @@ -18,7 +18,7 @@ command per \fIpay\fR, so this command should be used with caution\. .SH RETURN VALUE -On success, an array of objects is returned\. Each object contains: +On success, an array of objects is returned, ordered by increasing \fIid\fR\. Each object contains: \fIid\fR @@ -75,4 +75,4 @@ responsible\. Main web site: \fIhttps://github.com/ElementsProject/lightning\fR -\" SHA256STAMP:693da7a03235656092cc349b6b77335f71c3a1427d88f1cc8007ea7dd64a8e18 +\" SHA256STAMP:c6b36205c8067723bb9edc20f3645754faa9c9d26568d6c899721b43a1e99812 diff --git a/doc/lightning-listsendpays.7.md b/doc/lightning-listsendpays.7.md index 22a5e0e99..7752b7e73 100644 --- a/doc/lightning-listsendpays.7.md +++ b/doc/lightning-listsendpays.7.md @@ -20,7 +20,7 @@ command per *pay*, so this command should be used with caution. RETURN VALUE ------------ -On success, an array of objects is returned. Each object contains: +On success, an array of objects is returned, ordered by increasing *id*. Each object contains: *id* unique internal value assigned at creation