docs/comprehensive lncli #8181
docs/comprehensive lncli #8181
Conversation
ProofOfKeags
requested review from
ziggie1984,
guggero and
saubyk
and removed request for
guggero
saubyk
added
lncli
documentation
There was a problem hiding this comment.
Checked the new commands and their corresponding docs, looks good. Thank you for fixing this issue.
Because we do not automate this check, I think it would make sense to add a remark in the Contribution checklist or somewhere else otherwise we will diverge again ?
There was a problem hiding this comment.
Nice cleanup! Def agree that it needs contribution note (or gpt'ed up CI check 👀 ) to keep consistent.
ProofOfKeags
force-pushed
the
docs/comprehensive-lncli
branch
from
94d44d4
to
9fd18a7
Compare
| "editor.rulers": [ | ||
| 80 | ||
| ], | ||
| "go.buildTags": "autopilotrpc chainrpc dev invoicesrpc neutrinorpc peersrpc signrpc walletrpc watchtowerrpc" |
There was a problem hiding this comment.
Q: I wonder why you did not add the kv build tags for postgres or etcd ?
| @@ -16,7 +34,7 @@ service Router { | |||
| */ | |||
| rpc SendPaymentV2 (SendPaymentRequest) returns (stream lnrpc.Payment); | |||
There was a problem hiding this comment.
should we also add this and all others? I'm assuming they are not added here because they are not referenced in the API documentation tool?
There was a problem hiding this comment.
Correct. It's possible there is an existing incantation of lncli which uses this RPC but it wasn't obvious to me when I stepped through the various command services.
Change Description
Adds necessary tags to make all currently available lncli commands known to the API documentation tool. Fixes #8102
NOTE: this does not add any sort of checker to guarantee that these tags are always added. Such a facility would likely require a golang AST library and I'm not sure it's worth the work.
Steps to Test
Build the API documentation against this branch/commit and see if all available commands appear in the docs. I did this by hand. Doing this automatically would also require an AST traversing library.
Pull Request Checklist
Testing
Tests covering the positive and negative (error paths) are included.Bug fixes contain tests triggering the bug to prevent regressions.Code Style and Documentation
Any new logging statements use an appropriate subsystem and logging level.[skip ci]in the commit message for small changes.📝 Please see our Contribution Guidelines for further guidance.