Fix extra space generated by "generate_json_rpc_docs.py"#3737
Open
dingodoppelt wants to merge 1 commit into
Open
Fix extra space generated by "generate_json_rpc_docs.py"#3737dingodoppelt wants to merge 1 commit into
dingodoppelt wants to merge 1 commit into
Conversation
pljones
reviewed
Jun 15, 2026
| current_item.handle_text(line[len("/// @result "):]) | ||
| elif line.startswith("///"): | ||
| current_item.handle_text(line[len("///"):]) | ||
| current_item.handle_text(line[len("///") + 1:]) |
Collaborator
There was a problem hiding this comment.
Is + 1 safe? Wouldn't it be safer to trim leading space? Or pattern match ///<whitespace> and take everything after it. Or whatever python can do.
Member
Author
There was a problem hiding this comment.
Is
+ 1safe? Wouldn't it be safer to trim leading space? Or pattern match///<whitespace>and take everything after it. Or whatever python can do.
Yes, I guess matching the whitespace as well makes more sense here. Maybe @dtinth wants to have a look at this as well, since it is his code.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The python tool for generating the RPC documentation adds an extra space character after line breaks starting with /// because it treats the first space character as part of the string, this PR fixes it.
CHANGELOG: Fix extra space generated by "generate_json_rpc_docs.py" in multi line comments
Does this change need documentation? What needs to be documented and how?
No
Status of this Pull Request
Ready to be merged
Checklist