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.

Sign up for GitHub

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

Jump to bottom

Enforce CS1591 to document all public APIs in the repo #46283

Open
carlossanlop opened this issue Jan 24, 2025 · 0 comments
Open

Enforce CS1591 to document all public APIs in the repo #46283

carlossanlop opened this issue Jan 24, 2025 · 0 comments
Labels
Area-Infrastructure untriaged Request triage from a team member

Comments

@carlossanlop
Copy link
Member

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

sdk/.editorconfig

Line 268 in 35a8299

dotnet_diagnostic.CS1591.severity = suggestion

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Area-Infrastructure untriaged Request triage from a team member
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@carlossanlop