Add thread-safety comments about M.E.AI middleware components #5515
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
| /// It is expected that all implementations of <see cref="IChatClient"/> support being used by multiple requests concurrently. | ||
| /// </para> | ||
| /// <para> | ||
| /// However, implementations of <see cref="IChatClient"/> may mutate the arguments supplied to <see cref="CompleteAsync"/> and |
There was a problem hiding this comment.
"May" seems a bit weak given that mutating the list is the standard mechanism for updating the chat history.
Suggested change
| /// However, implementations of <see cref="IChatClient"/> may mutate the arguments supplied to <see cref="CompleteAsync"/> and | |
| /// However, implementations of <see cref="IChatClient"/> do mutate the arguments supplied to <see cref="CompleteAsync"/> and |
There was a problem hiding this comment.
To me that suggests that all implementations do, which isn't the case.
There was a problem hiding this comment.
Suggested change
| /// However, implementations of <see cref="IChatClient"/> may mutate the arguments supplied to <see cref="CompleteAsync"/> and | |
| /// However, implementations of <see cref="IChatClient"/> are permitted to mutate the arguments supplied to <see cref="CompleteAsync"/> and |
eiriktsarpalis
approved these changes
Oct 12, 2024
|
Ah, forgot I'd enabled auto merge :) |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes #5499
Microsoft Reviewers: Open in CodeFlow