Enable CS1591 errors for undocumented API #4230
Merged
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
Arcade by default NoWarns CS1591 errors. While that default is questionable, our team added a condition to not suppress that compiler error. Use that to enable CS1591 errors. ... and document the HttpClientBuilderExtensions class that was missing a class summary.
carlossanlop
approved these changes
Aug 1, 2023
ViktorHofer
added a commit
to dotnet/wcf
that referenced
this pull request
Aug 1, 2023
Similar as dotnet/extensions#4230, enable the CS1591 compiler errors when a library generates a documentation file.
|
FYI: @RussKie |
joperezr
approved these changes
Aug 1, 2023
|
FWIW I believe we have in extensions our own analyzers and rules that were checking for this, which leads me to question how come there seemed to be one violation we weren't catching. |
|
Just as an FYI, @carlossanlop will eventually send a PR to dotnet/extensions to add a transport package for the dotnet-api-docs team. More details in dotnet/runtime#996 (comment). That transport package will include both all reference assemblies and the compiler generated XML docs. |
ViktorHofer
added a commit
to dotnet/wcf
that referenced
this pull request
Aug 11, 2023
* Enable CS1591 errors for undocumented API Similar as dotnet/extensions#4230, enable the CS1591 compiler errors when a library generates a documentation file. * Update System.Web.Services.Description.csproj feedback from #5222 * Fix "build -vs" and adding /// comments to Federation --------- Co-authored-by: Matt Connew <[email protected]>
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Arcade by default NoWarns CS1591 errors. While that default is questionable, our team added a condition to not suppress that compiler error. Use that to enable CS1591 errors.
... and document the HttpClientBuilderExtensions class that was missing a class summary.
Microsoft Reviewers: Open in CodeFlow