Doc fixes for .NET 10 Preview 1 update #113027
Open
+14
−14
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
dotnet-issue-labeler
bot
added
the
needs-area-label
There was a problem hiding this comment.
PR Overview
This PR updates XML documentation comments for .NET 10 Preview 1 by replacing tags with tags and by standardizing boolean return values using and for consistency.
- Updated XML documentation in PhysicalFileProvider.cs
- Standardized boolean documentation in various AsyncEnumerable files
Reviewed Changes
| File | Description |
|---|---|
| src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileProvider.cs | Replaced with in doc comments for clarity. |
| src/libraries/System.Linq.AsyncEnumerable/src/System/Linq/AnyAsync.cs | Updated boolean return documentation markup. |
| src/libraries/System.Linq.AsyncEnumerable/src/System/Linq/AllAsync.cs | Updated boolean return documentation markup. |
| src/libraries/System.Linq.AsyncEnumerable/src/System/Linq/ContainsAsync.cs | Updated boolean return documentation markup. |
| src/libraries/System.Linq.AsyncEnumerable/src/System/Linq/SequenceEqualAsync.cs | Updated boolean return documentation markup. |
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
This was referenced Mar 1, 2025
carlossanlop
approved these changes
Mar 4, 2025
This is the source. I didn't fix in the API docs repo since I assume the XML file is refreshed for each preview? |
|
Microsoft.Extensions have triple slash comments as source of truth.
This is confusing me 😅 |
This was referenced Mar 4, 2025
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.
See dotnet/dotnet-api-docs#11032 build report.