Doc fixes for .NET 10 Preview 1 update #113027
Conversation
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 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 😅 |
|
@carlossanlop I'm not sure how to get this merged. By the time the checks finish, the branch is out of date. |
|
Don't press Update branch. If none of the failures is related to your changes, you can override that leg with a comment that starts with "/ba-g" followed by a brief explanation of your investigation confirming the failures are unrelated. |
|
/ba-g failures are BadExit, they're unrelated. Sorry I pressed close. |
|
Thanks @carlossanlop! |
See dotnet/dotnet-api-docs#11032 build report.