Fix rpc documentation for Router Service#10658
Fix rpc documentation for Router Service#10658saubyk wants to merge 2 commits intolightningnetwork:masterfrom
Conversation
Add lncli: tags to SendPaymentV2, SendToRouteV2, and EstimateRouteFee proto definitions so the generated API docs correctly show their corresponding CLI commands (sendpayment, sendtoroute, estimateroutefee) instead of "There is no CLI command for this RPC".
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses an issue with the generation of API documentation for the Router Service. By introducing specific Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request correctly adds the lncli: tags to several RPCs in the router.proto file, which will fix the generated API documentation. The changes are consistent and follow the project's conventions. I have one minor suggestion to update a placeholder in the release notes.
7a72c5e to
7b4ccd1
Compare
Change Description
lnclitag added toSendPaymentV2,SendToRouteV2andEstimateRouteFeerpcs to generate supporting API documentation for the shell commands.E.g currently: https://lightning.engineering/api-docs/api/lnd/router/send-to-route-v2/ shows
# There is no CLI command for this RPCon the shell section