Improve documentation for lsp-execute-code-action
#4097
Merged
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
`lsp-execute-code-action` is a user-facing function that can be executed e.g. when clangd says "fix available". But as it stands, the function description is too abstract, so unless you know details around lsp-protocol `codeAction`, you won't figure out what it's for. Fix that by clarifying what a user can use it for.
ericdallo
approved these changes
Jul 12, 2023
|
thank you! |
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.
lsp-execute-code-actionis a user-facing function that can be executed e.g. when clangd says "fix available". But as it stands, the function description is too abstract, so unless you know details around lsp-protocolcodeAction, you won't figure out what it's for. Fix that by clarifying what a user can use it for.This came up after me trying to find some way to "apply the clangd fix" and not finding anything useful offhand, and then going to gitter and asking a question there.