Update wtclient.go #9588

MKVEERENDRA · 2025-03-07T08:56:27Z

wtclient: Add descriptions for session and terminate commands
Improved user guidance by adding detailed CLI help text for the session and terminate subcommands in the watchtower client (wtclient).

Fixed formatting issues flagged by the linter.

Fixes: #9583

Change Description
Adds helpful descriptions for lncli wtclient session and lncli wtclient terminate to make the CLI more user-friendly. No logic changes.

Steps to Test

lncli wtclient
Check that the session and terminate commands now have clear descriptions.
make lint

PR Checklist
Passes all CI checks

Follows code and doc style (80 char lines, proper formatting)

Commits follow ideal structure

Not a typo-only change

No tests required (CLI help text only)

No release notes change needed

coderabbitai · 2025-03-07T08:56:37Z

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)

llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

cmd/commands/wtclient.go

ellemouton · 2025-03-07T16:38:23Z

thanks for the contribution @MKVEERENDRA ,

Please read through our contribution guidelines: Contribution Guidelines

where you will find info on: how to structure commits & how to name commits 🙏

twofaktor · 2025-03-07T18:11:23Z

utACK

MKVEERENDRA · 2025-03-08T10:41:15Z

@ellemouton ok I will do that to further PR.

MKVEERENDRA · 2025-03-08T10:42:44Z

@dennisreimann can you pls review my PR.

yyforyongyu · 2025-03-08T14:01:55Z

what's the difference between this and #9584?

MKVEERENDRA · 2025-03-09T11:32:07Z

what's the difference between this and #9584?

The previous PR (#9584) was addressing the same issue, but I decided to delete it and create a new one to ensure a cleaner commit history and follow best practices.

Biloparoch

Ok

yyforyongyu · 2025-03-09T15:31:51Z

As mentioned above and in this comment, PRs must follow the contribution guidelines.

twofaktor · 2025-04-14T08:49:10Z

Will anyone on the team continue to follow up on this PR? Issue related #9583

saubyk · 2025-04-14T15:11:51Z

Will anyone on the team continue to follow up on this PR? Issue related #9583

Haven't seen any update after the last review comment. Ball's in @MKVEERENDRA 's court

twofaktor · 2025-04-15T09:15:15Z

Will anyone on the team continue to follow up on this PR? Issue related #9583

Haven't seen any update after the last review comment. Ball's in @MKVEERENDRA 's court

If this guy never responds again, will no one from the Lightning Labs team take care of it?

ellemouton · 2025-04-15T10:12:19Z

If this guy never responds again, will no one from the Lightning Labs team take care of it?

@twofaktor - it's not a high prio issue & also is a really nice first-contribution project, so ideally would like to leave it for someone looking to make their first contribution to lnd.

MKVEERENDRA · 2025-04-15T11:37:23Z

Hey @ellemouton @twofaktor 👋

Apologies for the delay. I'm ready to wrap this up and would love to get this PR merged. Let me know if there's anything else you'd like me to update or improve. Happy to make any recommended changes. Thanks!

twofaktor

utACK

twofaktor · 2025-04-15T19:40:28Z

@ellemouton could you review this PR?

AbhinavAnand241201

ACK with a small suggestion:

The changes improve the CLI help text by making descriptions clearer and more informative. The formatting is correct and the changes are focused.

One small suggestion: In the terminateSessionCommand, changing ArgsUsage: "id" to ArgsUsage: "session_id" would make it even clearer what kind of ID is expected, consistent with the improved clarity in the rest of the changes.

Overall, good improvements to the CLI documentation!

MKVEERENDRA · 2025-04-16T04:17:43Z

Thanks! @AbhinavAnand241201 Appreciate the ACK and the helpful suggestion.

You're absolutely right — changing ArgsUsage: "id" to ArgsUsage: "session_id" makes the help text more explicit and aligned with the rest of the improvements. Just pushed that update 🙌

Let me know if you spot anything else!

AbhinavAnand241201

i noticed u worked on the optional improvement,... i suggested upon .. ....
everything else looks fine ..
👍🏻

ellemouton

@MKVEERENDRA
As requested a couple times before, please read our contribution guidelines regarding how to go about structuring commits and titling commits. Also, I think previously I made this comment on another PR but then you closed that in order to open this one. Rather just push changes to this PR instead of opening a new on. The changes in this PR can really all just be in a single commit.

… fixes. - Added detailed descriptions for the session and terminate commands in wtclient to improve user guidance and clarity. - Changed the ArgsUsage for the session command from 'id' to 'session_id'. - Refined descriptions to explain the purpose of each command. - Fixed long description lines to adhere to the 80-character line limit. - Updated the release notes for version 0.19.0. Fixes: lightningnetwork#9583

MKVEERENDRA · 2025-04-24T19:36:04Z

@yyforyongyu Why was the PR closed without merging? There were unmerged commits — should we reopen it or create a new one?

MKVEERENDRA · 2025-04-24T19:38:48Z

@saubyk can you reopen it or please clarify that like why it was closed.

ellemouton · 2025-04-25T06:04:44Z

@MKVEERENDRA - i've reopened it

ellemouton · 2025-04-26T05:58:32Z

@MKVEERENDRA - note that commit message structure has still not been followed here. please read our guidelines carefully

MKVEERENDRA · 2025-04-29T14:24:02Z

@ellemouton "note that commit message structure has still not been followed here. please read our guidelines carefully" -- Can you pls elaborate that what I not been followed, I am bit confused like I read the guidelines carefully and did many changes like detail commit messages and strink commit ..etc, but I did not find any difference like what is wrong.
Further details help me alot.

ellemouton · 2025-05-05T06:21:13Z

@MKVEERENDRA - see here

lightninglabs-deploy · 2025-05-12T07:21:54Z

@ellemouton: review reminder

ellemouton

please re-request once updated

twofaktor · 2025-05-12T19:56:26Z

please re-request once updated

It is being worked on in parallel PR #9765 which seems more appropriate

saubyk · 2025-05-12T20:54:03Z

It is being worked on in parallel PR #9765 which seems more appropriate

In that case, can we close this pr now?

MKVEERENDRA · 2025-05-13T03:04:10Z

Alright, if PR #9765 is more appropriate, let's go ahead and close this one.

The reason I initially opened this PR was to contribute the changes quickly, but since it's now being handled better in parallel, I'm happy to close it here.

Also, @ellemouton — you mentioned "commit message structure has still not been followed." I did read the contribution guidelines carefully and tried to apply them (added detailed messages, squashed commits, etc.), so I’m not exactly sure what I missed.

Could you please help clarify what specifically was incorrect? That would help me a lot to improve in the future.

Thanks!

ellemouton · 2025-05-13T05:15:35Z

@MKVEERENDRA - did you see the link I posted above? this one?

basically you need to have a short (max 50 char title) that starts with the package being touched in that commit and then you can follow it with a description body that wraps at 80.

So a title for this commit could have been: cmd/commands: add descriptions to tower commands

MKVEERENDRA · 2025-05-13T07:07:58Z

@ellemouton Ohh now I get it, Tq for the information.

MKVEERENDRA force-pushed the master branch from ff1e07c to 30a3c97 Compare March 7, 2025 09:04

MKVEERENDRA mentioned this pull request Mar 7, 2025

[bug]: missing description to wtclient command "session" and "terminate" command option #9583

Closed

twofaktor reviewed Mar 7, 2025

View reviewed changes

cmd/commands/wtclient.go Outdated Show resolved Hide resolved

twofaktor approved these changes Mar 7, 2025

View reviewed changes

Biloparoch approved these changes Mar 9, 2025

View reviewed changes

saubyk mentioned this pull request Mar 19, 2025

Add the descriptions of the session and the terminate command #9615

Closed

9 tasks

hieblmi added the good first review Pull Requests that are suitable for new contributors that want to learn code review label Mar 28, 2025

saubyk assigned MKVEERENDRA Apr 14, 2025

twofaktor approved these changes Apr 15, 2025

View reviewed changes

saubyk added this to the v0.20.0 milestone Apr 15, 2025

AbhinavAnand241201 suggested changes Apr 15, 2025

View reviewed changes

MKVEERENDRA requested a review from AbhinavAnand241201 April 16, 2025 09:27

AbhinavAnand241201 approved these changes Apr 17, 2025

View reviewed changes

ellemouton self-requested a review April 17, 2025 13:49

ellemouton requested changes Apr 17, 2025

View reviewed changes

MKVEERENDRA force-pushed the master branch from c7e7f74 to 9cfb608 Compare April 17, 2025 16:21

yyforyongyu closed this Apr 24, 2025

ellemouton reopened this Apr 25, 2025

ellemouton mentioned this pull request Apr 26, 2025

cmd/wtclient: Enhance help text for session and terminate subcommands #9765

Closed

8 tasks

MKVEERENDRA requested a review from ellemouton April 30, 2025 04:09

ellemouton reviewed May 12, 2025

View reviewed changes

saubyk closed this May 13, 2025

Update wtclient.go #9588

Update wtclient.go #9588

Uh oh!

Conversation

MKVEERENDRA commented Mar 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Mar 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

ellemouton commented Mar 7, 2025

Uh oh!

twofaktor commented Mar 7, 2025

Uh oh!

MKVEERENDRA commented Mar 8, 2025

Uh oh!

MKVEERENDRA commented Mar 8, 2025

Uh oh!

yyforyongyu commented Mar 8, 2025

Uh oh!

MKVEERENDRA commented Mar 9, 2025

Uh oh!

Biloparoch left a comment

Choose a reason for hiding this comment

Uh oh!

yyforyongyu commented Mar 9, 2025

Uh oh!

twofaktor commented Apr 14, 2025

Uh oh!

saubyk commented Apr 14, 2025

Uh oh!

twofaktor commented Apr 15, 2025

Uh oh!

ellemouton commented Apr 15, 2025

Uh oh!

MKVEERENDRA commented Apr 15, 2025

Uh oh!

twofaktor left a comment

Choose a reason for hiding this comment

Uh oh!

twofaktor commented Apr 15, 2025

Uh oh!

AbhinavAnand241201 left a comment

Choose a reason for hiding this comment

Uh oh!

MKVEERENDRA commented Apr 16, 2025

Uh oh!

AbhinavAnand241201 left a comment

Choose a reason for hiding this comment

Uh oh!

ellemouton left a comment

Choose a reason for hiding this comment

Uh oh!

MKVEERENDRA commented Apr 24, 2025

Uh oh!

MKVEERENDRA commented Apr 24, 2025

Uh oh!

ellemouton commented Apr 25, 2025

Uh oh!

ellemouton commented Apr 26, 2025

Uh oh!

MKVEERENDRA commented Apr 29, 2025

Uh oh!

ellemouton commented May 5, 2025

Uh oh!

lightninglabs-deploy commented May 12, 2025

Uh oh!

ellemouton left a comment

Choose a reason for hiding this comment

Uh oh!

twofaktor commented May 12, 2025

Uh oh!

saubyk commented May 12, 2025

MKVEERENDRA commented Mar 7, 2025 •

edited

Loading

coderabbitai bot commented Mar 7, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

ellemouton commented May 13, 2025 •

edited

Loading