Skip to content

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

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

Jump to bottom
Open
twofaktor opened this issue Mar 5, 2025 · 10 comments · May be fixed by #9588 or #9765
Open

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

twofaktor opened this issue Mar 5, 2025 · 10 comments · May be fixed by #9588 or #9765
Labels
documentation Documentation changes that do not affect code behaviour good first issue Issues suitable for first time contributors to LND rpc Related to the RPC interface up for grabs PRs which have been abandoned by their original authors and can be taken up by someone else watchtower

Comments

@twofaktor
Copy link
Contributor

twofaktor commented Mar 5, 2025 •
edited
Loading

Background

After navigating around the lncli wtclient subcommands, I noticed there are missing descriptions and "how to use" for session and terminate command options

Your environment

  • version of lnd: 0.18.5
  • which operating system: Ubuntu Server Jammy LTS
  • version of btcd, bitcoind, or other backend: bitcoind

Steps to reproduce

Navigate around the lncli wtclient subcommands

Expected behaviour

Detailed description of "how to use" for session and terminate subcommand option

Actual behaviour

Missing information

Screenshots

Image

Possible code lines to be addressed

https://github.com/lightningnetwork/lnd/blob/master/cmd/commands/wtclient.go#L378-L420

Edit:
PR related: #9588
@twofaktor twofaktor added bug Unintended code behaviour needs triage labels Mar 5, 2025
@guggero guggero added rpc Related to the RPC interface documentation Documentation changes that do not affect code behaviour up for grabs PRs which have been abandoned by their original authors and can be taken up by someone else good first issue Issues suitable for first time contributors to LND and removed bug Unintended code behaviour needs triage labels Mar 5, 2025
@MKVEERENDRA MKVEERENDRA mentioned this issue Mar 5, 2025
Closed
MKVEERENDRA added a commit to MKVEERENDRA/lnd that referenced this issue Mar 7, 2025
@MKVEERENDRA
Update wtclient.go
ff1e07c 
wtclient: Add descriptions for session and terminate commands

- Added detailed descriptions for the watchtower client session and terminate commands to improve user guidance.
- Fixed formatting issues as per linter requirements.
- Updated release notes for version 0.19.0.

Fixes lightningnetwork#9583
@MKVEERENDRA MKVEERENDRA linked a pull request Mar 7, 2025 that will close this issue
Open
MKVEERENDRA added a commit to MKVEERENDRA/lnd that referenced this issue Mar 7, 2025
@MKVEERENDRA
Update wtclient.go
30a3c97 
wtclient: Add descriptions for session and terminate commands

- Added detailed descriptions for the watchtower client session and terminate commands to improve user guidance.
- Fixed formatting issues as per linter requirements.
- Updated release notes for version 0.19.0.

Fixes lightningnetwork#9583
@MKVEERENDRA
Copy link

#9588 Pls check this

@twofaktor
Copy link
Contributor Author

twofaktor commented Mar 7, 2025 •
edited
Loading

Checked, see comment

@B1n4ryR41nb0w
Copy link

is this still in the need of a triage?

Closed
9 tasks
@shivansh-bhatnagar18
Copy link

@twofaktor The sessionCommands currently contains only the terminate command for the watchtower operations which itself has a command terminate. So added the description accordingly

@AbhinavAnand241201
Copy link

can i create a PR for this ??...

@twofaktor
Copy link
Contributor Author

can i create a PR for this ??...

There's already a PR #9588 underway, although it's a bit abandoned. If you want to take it up again...go ahead

MKVEERENDRA added a commit to MKVEERENDRA/lnd that referenced this issue Apr 15, 2025
@MKVEERENDRA
Update wtclient.go
1adcd32 
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).

Fixes: lightningnetwork#9583

Changed 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

1. lncli wtclient --Check that the session and terminate commands now have clear descriptions.

2. make lint
@AbhinavAnand241201
Copy link

AbhinavAnand241201 commented Apr 15, 2025 •
edited
Loading

@twofaktor should i submit a PR or leave it cuz i can see the guy is active now and he has made a commit ....

@saubyk
Copy link
Collaborator

saubyk commented Apr 15, 2025

@twofaktor should i submit a PR or leave it cuz i can see the guy is active now and he has made a commit ....

Hi @AbhinavAnand241201 you can try to review the pr instead

@AbhinavAnand241201
Copy link

AbhinavAnand241201 commented Apr 15, 2025 •
edited
Loading

@twofaktor should i submit a PR or leave it cuz i can see the guy is active now and he has made a commit ....

Hi @AbhinavAnand241201 you can try to review the pr instead

yess exactly ...i was going to do this ..but was waiting for @twofaktor 's reply...
since this guy @MKVEERENDRA
was inactive for quite some time ...and he might vanish again ....so i was a bit unsure...but for now i'll review the PR instead ..

@MKVEERENDRA
Copy link

Thanks for the heads-up, @AbhinavAnand241201 and @saubyk.

Totally fair point — I had been a bit inactive earlier, but I’m back on this now and will be maintaining the PR actively. That said, I really appreciate you checking in and offering to help. If you spot anything in the PR that can be improved, I’d love your feedback or suggestions in the review!

Let’s collaborate and get it merged properly 💪

MKVEERENDRA added a commit to MKVEERENDRA/lnd that referenced this issue Apr 16, 2025
@MKVEERENDRA
Update wtclient.go
82bc9eb 
Enhanced user guidance by refining CLI help descriptions for the `session` and `terminate` subcommands under the watchtower client (wtclient). Specifically changed `ArgsUsage` from "id" to "session_id" to improve clarity and consistency across the CLI.

Fixes: lightningnetwork#9583

Changed Description:
- Updated `lncli wtclient session` and `lncli wtclient terminate` descriptions to be more user-friendly and descriptive.
- Changed `ArgsUsage: "id"` to `ArgsUsage: "session_id"` for clearer CLI documentation.
- No logic changes; this is a documentation/help text improvement only.

Steps to Test:

1. Run `lncli wtclient` and ensure the session and terminate commands display clear, descriptive help text.
2. Run `make lint` to confirm no linting issues are introduced.
MKVEERENDRA added a commit to MKVEERENDRA/lnd that referenced this issue Apr 17, 2025
@MKVEERENDRA
Update wtclient CLI commands with refined descriptions and formatting…
9cfb608 
… 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
@gap-editor gap-editor linked a pull request Apr 25, 2025 that will close this issue
Open
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Documentation changes that do not affect code behaviour good first issue Issues suitable for first time contributors to LND rpc Related to the RPC interface up for grabs PRs which have been abandoned by their original authors and can be taken up by someone else watchtower
Projects
None yet
Milestone
No milestone
7 participants
@guggero @saubyk @twofaktor @shivansh-bhatnagar18 @B1n4ryR41nb0w @MKVEERENDRA @AbhinavAnand241201