Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make some command docs clearer and more descriptive #4286

Closed
wants to merge 2 commits into from
Closed

Make some command docs clearer and more descriptive #4286

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01c111c
clarify property descriptions and examples in many command docs.
Dec 18, 2020
5242e1b
fix grammar.
fiatjaf Dec 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions doc/lightning-getinfo.7
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 15 additions & 15 deletions doc/lightning-getinfo.7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,21 +27,21 @@ RETURN VALUE

On success, an object with the following information is returned:

- *id*: A string that represents the public key of the node. It will represents the node on the public network.
- *alias*: A string that represents the alias of the node, by default is calculate from the public key (node id). This is just for fun; the name can be anything and is not unique!
- *color*: A string that represents the preferred color of the node.
- *num_peers*: An integer that represents the number of peer connect to the node.
- *num_pending_channels*: An integer that represents the number of channel which are still awaiting opening confirmation.
- *num_active_channels*: A integer that represents the number of channel which are currently open.
- *num_inactive_channels*: A integer that represents the number of channel which are closing.
- *address*: An array that represents all published addresses of the node, each object inside the array contains the following proprieties:
- *type*: A string that represents the type of the address (currently `ipv4`, `ipv6`, `torv3` or `torv4`).
- *address*: A string that represents the value of the address.
- *port*: An integer that represents the port where the node is listening with this address.
- *binding*: An array that represents all addresses where the node is binded. Each object contains the same object type of the address propriety above.
- *version*: A string that represents the version of the node.
- *blockheight*: An integer that represents the blockchain height.
- *network*: A string that represents the type of network on the node are working (e.g: `bitcoin`, `testnet`, or `regtest`).
- *id*: Hex-encoded public key of the node. It will represents the node on the public network.
fiatjaf marked this conversation as resolved.
Show resolved Hide resolved
- *alias*: User-chosen node name, by default is calculated from the public key (node id). This is just for fun; the name can be anything and is not unique!
- *color*: User-chosen node color as a hexadecimal string. Like the alias, this is just for fun.
- *num_peers*: Number of peer connected.
- *num_pending_channels*: Number of channels which are still awaiting opening confirmation.
- *num_active_channels*: Number of channels which are currently open.
- *num_inactive_channels*: Number of channels which are closing.
- *address*: An array with the published addresses of the node as objects, each object contains the following properties:
- *type*: Address type (`"ipv4"`, `"ipv6"`, `"torv2"` or `"torv3"`).
- *address*: IP or `.onion` hidden service address as a string.
- *port*: Port number as an integer.
- *binding*: An array with addresses to which the node is bound. Properties of the objects are the same as above.
- *version*: Version of the lightningd software currently running.
- *blockheight*: Height of the last Bitcoin block processed by the node.
- *network*: Bitcoin network the node is currently running on (e.g: `bitcoin`, `testnet`, or `regtest`).

On failure, one of the following error codes may be returned:

Expand Down
18 changes: 9 additions & 9 deletions doc/lightning-getlog.7
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 9 additions & 9 deletions doc/lightning-getlog.7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ DESCRIPTION

The **getlog** the RPC command to show logs, with optional log *level*.

- *level*: A string that represents the log level (*broken*, *unusual*, *info*, *debug*, or *io*). The default is *info*.
- *level*: Desired log level (*broken*, *unusual*, *info*, *debug*, or *io*) to filter on. The default is *info*.

EXAMPLE JSON REQUEST
--------------------
Expand All @@ -30,16 +30,16 @@ RETURN VALUE

On success, a object will be return with the following parameters:

- *created_at*: An floating point value that represents the UNIX timestamp when logging began.
- *bytes_used*: A string that represents the dimension in bytes of the log file.
- *bytes_max*: An integer that represents the max dimension in bytes of log file.
- *created_at*: The UNIX timestamp of when the logging began as a float.
- *bytes_used*: Size in bytes of the log file.
- *bytes_max*: Maximum size in bytes of the log file.
- *log*: An array of objects where each element contains the following proprieties:
- *type*: A string that represents the log level. The propriety can have an value equal to SKIPPED to indicate the existence of omitted entries.
- *time*: A floating point value that represents the time since *created_at*.
- *source*: A string that represents the source of line.
- *log*: A string that represents the content of line.
- *type*: The log level of this entry. This property can have a value equal to `"SKIPPED"` to indicate the existence of omitted entries.
- *time*: A floating point value that represents the time passed since *created_at*.
- *source*: The file that emitted this log entry.
- *log*: The log contents.
- *num_skipped*: An integer that it is present only if the log level is equal to SKIPPED.


On failure, one of the following error codes may be returned:

Expand Down
8 changes: 4 additions & 4 deletions doc/lightning-help.7
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions doc/lightning-help.7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ RETURN VALUE
On success, a object will be return with the following proprieties:

- *command*: A string that represents the stucture of the command.
- *category*: A string that represents the category.
- *description*: A string that represents the description.
- *verbose*: A string that represents the verbode description.
- *category*: Command category.
- *description*: A short description of the command and its basic parameters.
- *verbose*: A longer description of what the command does.

On failure, one of the following error codes may be returned:

Expand Down
12 changes: 6 additions & 6 deletions doc/lightning-listconfigs.7
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions doc/lightning-listconfigs.7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ the configuration file(s) and command line.

Additional members include:

- *# version*: A string that represents the version of node.
- *plugins*: A array that represents the non-important plugin registered. Each object contains the following members:
- *path*: A string that represents the path of plugin.
- *name*: A string that represents the name of plugin.
- *# version*: Version of lightningd software that is currently running.
- *plugins*: A array of the non-important plugin currently running. Each object contains the following members:
- *path*: Path of the plugin executable.
- *name*: The plugin name.
- *options*: A object that contains all options accepted from command line or configuration file, if the plugin has opitions
- *important-plugins*: An array that represents all important plugins registered to the node. Each object contains the same members as the *plugin* array.
- *important-plugins*: An array of the important plugins currently running. Each object contains the same members as the *plugin* array.

On failure, one of the following error codes may be returned:

Expand Down
22 changes: 11 additions & 11 deletions doc/lightning-listnodes.7
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 12 additions & 12 deletions doc/lightning-listnodes.7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,22 @@ RETURN VALUE

On success, the command will return a list of nodes, each object represents a node, with the following details:

- *nodeid*: A string that represents the node id.
- *nodeid*: Hex-encoded pubkey of the node.

For nodes which have sent a node_announcement message, the following
are also returned:

- *alias*: A string that represents alias of the node on the network.
- *color*: A string that represents the personal color of the node.
- *last_timestamp*: An integer that represents the timestamp of the last-received node_announcement message.
- *features*: A string that represents the features value.
- *addresses*: An array that represents the addreses avaible. Each address is represented with an object with the following properties:
- *type*: A string that represents the address type (ipv4 or ipv6).
- *address*: A string that represents the address value.
- *port*: An integer that represents the port number where the node are listening.
- *alias*: The user-chosen node name as a string.
- *color*: The user-chosen node color as a hexadecimal string.
- *last_timestamp*: The last-received node_announcement message as a UNIX timestamp integer.
- *features*: Hex-encoded features bitstring.
- *addresses*: An array of the node's public addresses. Each address is represented by an object with the following properties:
- *type*: Address type (`"ipv4"`, `"ipv6"`, `"torv2"` or `"torv3"`).
- *address*: IP or `.onion` hidden service address as a string.
- *port*: Port number as an integer.

On failure, one of the following error codes may be returned:

- -32602: Error in given parameters.

EXAMPLE JSON RESPONSE
Expand Down Expand Up @@ -78,7 +78,7 @@ Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version o
SEE ALSO
--------

FIXME:
FIXME:

RESOURCES
---------
Expand Down
Loading