Add API docs for Caching and WebEncoders #28945
Merged
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
JunTaoLuo
commented
Dec 31, 2020
pranavkm
reviewed
Dec 31, 2020
| @@ -12,11 +12,13 @@ namespace Microsoft.Extensions.WebEncoders.Testing | |||
| /// </summary> | |||
| public sealed class HtmlTestEncoder : HtmlEncoder | |||
| { | |||
| /// <inheritdoc /> | |||
There was a problem hiding this comment.
Could we enhance the summary for this type to say something about not using it in production apps?
There was a problem hiding this comment.
Same for the other test encoders
There was a problem hiding this comment.
The type summary already indicates that it's used for testing only. Didi you want to add it to all the method docs as well?
There was a problem hiding this comment.
It feels a bit spare. How about
<see cref="HtmlEncoder" />used for unit testing. This encoder does not perform any encoding and should not be used in application code.
There was a problem hiding this comment.
Updated for all three encoders.
mkArtakMSFT
added
the
feature-caching
Co-authored-by: Pranav K <[email protected]>
|
ping @pranavkm for review. |
pranavkm
approved these changes
Jan 5, 2021
amcasey
added
the
area-middleware
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.
Part of #27538.