Update PureAttribute documentation to mention CA1806 analyzer enforcement #11949
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.
Summary
This PR updates the documentation for
System.Diagnostics.Contracts.PureAttribute
to clarify that the CA1806 code analyzer enforces this attribute.Changes
The previous documentation stated:
This statement is outdated. The CA1806 analyzer does check for the
[Pure]
attribute and emits diagnostics when methods marked as pure have their return values ignored.The updated documentation now states:
Context
When a method is marked with
[Pure]
, CA1806 emits the following diagnostic if the return value isn't used:This change helps developers understand that applying the
[Pure]
attribute has practical effects in modern code analysis tooling.Fixes #(issue number from dotnet/docs repository)
Original prompt
Fixes dotnet/docs#48767
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.