-
Notifications
You must be signed in to change notification settings - Fork 4.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enable CS1591 in System.Formats.Cbor #83837
Conversation
Tagging subscribers to this area: @dotnet/area-system-security, @vcsjones Issue DetailsPartially addresses: #49120 CS1591 is the rule that makes triple slash comments mandatory in public APIs. It was globally suppressed in Arcade, which wasn't ideal, but we introduced a property in dotnet/arcade#12188 to allow using the rule in specific assemblies. We enabled the And now we can use it in the assembly that can successfully generate its own triple slash xml as source of truth.
|
Tagging subscribers to this area: @dotnet/area-system-formats-cbor, @vcsjones Issue DetailsPartially addresses: #49120 CS1591 is the rule that makes triple slash comments mandatory in public APIs. It was globally suppressed in Arcade, which wasn't ideal, but we introduced a property in dotnet/arcade#12188 to allow using the rule in specific assemblies. We enabled the And now we can use it in the assembly that can successfully generate its own triple slash xml as source of truth.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The SkipArcadeNoWarnCS1591
must be set to true in order for Arcade to not add a NoWarn for 1591: https://github.com/dotnet/arcade/blob/0c2fe2f838e63ad8cd9fb14927547479db9a18f1/src/Microsoft.DotNet.Arcade.Sdk/tools/ProjectDefaults.props#L95
Libraries in dotnet/runtime already set it to true for all projects:
<SkipArcadeNoWarnCS1591>true</SkipArcadeNoWarnCS1591> |
Intellisense.targets then adds the actual NoWarn 1591 for all libraries that use the intellisense package xml file:
runtime/eng/intellisense.targets
Line 18 in 967250c
<NoWarn Condition="'$(UseIntellisensePackageDocXmlFile)' == 'true'">$(NoWarn);1591</NoWarn> |
Then I think issue #49120 can be closed. |
Partially addresses: #49120
CS1591 is the rule that makes triple slash comments mandatory in public APIs.
It was globally suppressed in Arcade, which wasn't ideal, but we introduced a property in dotnet/arcade#12188 to allow using the rule in specific assemblies.
We enabled the
SkipArcadeNoWarnCS1591
property by default in the runtime repo with PR: #79134And now we can use it in the assembly that can successfully generate its own triple slash xml as source of truth.
I manually tested that the rule works by: