docs: conversation-based agents #387
Open
Conversation
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
volodkevych
reviewed
Mar 21, 2025
| @@ -1,5 +1,6 @@ | |||
| import { URI, TextDocument } from './lsp' | |||
|
|
|||
| /** Server to client. Used to ask the user to select a folder, if the workspace folder is too big */ | |||
There was a problem hiding this comment.
"Server to client" is specified in README - I would prefer to keep it there, specifying the direction of request in one place only looks inconsistent to me.
"if the workspace folder is too big" - this is just one of examples when it will be used, I do not think we need it in comment like this.
"select a folder" -> "select files(s) or folder(s)"
volodkevych
reviewed
Mar 21, 2025
| originalFileUri: URI | ||
| /** Indicates if the original file was deleted and fileContent contains the new/updated file contents. */ |
There was a problem hiding this comment.
can we please spilt it into 2 comments for 2 fields?
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.
Problem
conversational chat protocol added in #368 had some comments that give practical info about the protocol.
Solution
add the info to docstrings.
License
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.