dotnet / dotnet/sdk

[Compatibility] Enforce CS1591 to document all public APIs

Open
#46,283 3 comments 0 reactions 0 assignees View on GitHub
Area-ApiCompat
Dominant language
C#
Stars
3.2k
Forks
1.3k
PR merge metrics
PR metrics pending

Description

CS1591 has severity set to suggestion in the root .editorconfig:

https://github.com/dotnet/sdk/blob/35a8299fcb0cb13da87c32166ecafd219dd9206c/.editorconfig#L268

We should change it to warning so that public APIs are triple-slash documented.

There might be other infra configuration changes to ensure docs work properly at the repo level.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.