pyln-client+cli: Fix formatting issues for plugin description in lightning-cli help #8022
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rustyrussell
requested changes
Jan 28, 2025
Comment on lines
-87
to
92
| args.append("\n%s" % self.description) | ||
| doc = inspect.getdoc(self.func) | ||
| doc = re.sub('\n+', ' | ', doc) | ||
| args.append(" | %s" % doc) | ||
|
|
||
| return " ".join(args) | ||
|
|
There was a problem hiding this comment.
This should be in the next commit?
Also, the Changelog line for the first commit is unnecessary: this isn't a user-visible change!
cli/lightning-cli.c
Outdated
Comment on lines
200
to
214
| printf("%.*s\n\n", | ||
| command->end - command->start, buffer + command->start); | ||
| human_readable(buffer, command, '\n'); | ||
| printf("\n"); | ||
| } |
There was a problem hiding this comment.
human_readable() is used in other contexts, and this will break it. In particular, the summary plugin.
I think this replacement needs to occur inline:
static void replace_char(char *buf, size_t len, char old, char new)
{
char *p = buf, *end = buf + len;
while ((p = memchr(p, old, end - p)) != NULL)
*p = new;
}
Then simply call replace_char(buffer + command->start, command->end - command_start, '|', '\n') here.
There was a problem hiding this comment.
Done; however, this part:
else if (buffer[i] == '|') {
fputc('\n', stdout);
continue;
} is necessary for formatting the help output in cases of commands like lightning-cli help funds or lightning-cli help funds -H for external plugins such as funds.
The `doc` variable was being initialised and processed but not used anywhere. Changelog-None Signed-off-by: Nishant Bansal <[email protected]>
Changelog-Changed: Replaced \n with | as the line separator in the plugin to enhance the readability of lightning-cli help. Signed-off-by: Nishant Bansal <[email protected]>
Changelog-Changed: Updated the `lightning-cli help` output by replacing '\n' with '|' as a line separator, enhancing readability and consistency. Signed-off-by: Nishant Bansal <[email protected]>
NishantBansal2003
force-pushed
the
plugin-help
branch
from
90d9502 to
b1fe851
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #8020
Improved formatting of plugin descriptions displayed in the
lightning-cli helpoutput: Previously, the descriptions contained unnecessary\ncharacters when shown as a single line, which affected readability.Proposed Solution: Replace
\nwith|as the line separator when output is displayed in a single line, for better clarity and consistency.Removed unused variables and related code from
pyln-client: For example, thedocvariable inpyln/client/plugin.pywas declared but never utilized, and related code was cleaned up to improve maintainability.Important
24.11 FREEZE NOVEMBER 7TH: Non-bugfix PRs not ready by this date will wait for 25.02.
Checklist
Before submitting the PR, ensure the following tasks are completed. If an item is not applicable to your PR, please mark it as checked: