Skip to content
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

Closed
wants to merge 1 commit into from

Conversation

carlossanlop
Copy link
Member

@carlossanlop carlossanlop commented Mar 23, 2023

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: #79134

And 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:

  • Building the assembly. It succeeds, all public APIs are documented as expected.
  • Removing an existing triple slash line from a public API, then building. It fails with the expected error message.

@ghost
Copy link

ghost commented Mar 23, 2023

Tagging subscribers to this area: @dotnet/area-system-security, @vcsjones
See info in area-owners.md if you want to be subscribed.

Issue Details

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: #79134

And now we can use it in the assembly that can successfully generate its own triple slash xml as source of truth.

Author: carlossanlop
Assignees: -
Labels:

area-System.Security

Milestone: -

@ghost
Copy link

ghost commented Mar 23, 2023

Tagging subscribers to this area: @dotnet/area-system-formats-cbor, @vcsjones
See info in area-owners.md if you want to be subscribed.

Issue Details

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: #79134

And now we can use it in the assembly that can successfully generate its own triple slash xml as source of truth.

Author: carlossanlop
Assignees: carlossanlop
Labels:

area-System.Formats.Cbor

Milestone: -

Copy link
Member

@ViktorHofer ViktorHofer left a 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:

<NoWarn Condition="'$(UseIntellisensePackageDocXmlFile)' == 'true'">$(NoWarn);1591</NoWarn>

@ghost ghost added the needs-author-action An issue or pull request that requires more info or actions from the author. label Mar 23, 2023
@carlossanlop
Copy link
Member Author

Then I think issue #49120 can be closed.

@carlossanlop carlossanlop deleted the CborEnableCS1591 branch March 23, 2023 21:25
@ghost ghost locked as resolved and limited conversation to collaborators Apr 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-System.Formats.Cbor needs-author-action An issue or pull request that requires more info or actions from the author.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants