Improve XML documentation clarity for IMethodSymbol.Arity property#80693
Merged
CyrusNajmabadi merged 3 commits intomainfrom Oct 16, 2025
Merged
Improve XML documentation clarity for IMethodSymbol.Arity property#80693CyrusNajmabadi merged 3 commits intomainfrom
CyrusNajmabadi merged 3 commits intomainfrom
Conversation
Co-authored-by: CyrusNajmabadi <4564579+CyrusNajmabadi@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Improve quick info documentation for Arity
Improve XML documentation clarity for IMethodSymbol.Arity property
Oct 14, 2025
CyrusNajmabadi
approved these changes
Oct 14, 2025
Contributor
|
@dotnet/roslyn-compiler ptal. |
jcouv
reviewed
Oct 15, 2025
|
|
||
| /// <summary> | ||
| /// Returns the arity of this method, or the number of type parameters it takes. | ||
| /// Returns the arity of this method. Arity is the number of type parameters a method takes. |
Member
Contributor
There was a problem hiding this comment.
'Takes' sounds right to me. A method takes these parameters. It takes an int, and a string, and a bool. But i'm also fine with updating it to 'declares'. @copilot can you update this to ".. the number of type parameters a method declares"?
Contributor
Author
There was a problem hiding this comment.
Updated to use "declares" instead of "takes" in commit ae871df.
Member
There was a problem hiding this comment.
declares sounds correct to me. takes feels more informal, and we tend to try to be precise in these.
jcouv
reviewed
Oct 15, 2025
Member
jcouv
left a comment
There was a problem hiding this comment.
Done with review pass (commit 2)
Co-authored-by: CyrusNajmabadi <4564579+CyrusNajmabadi@users.noreply.github.com>
333fred
approved these changes
Oct 15, 2025
This was referenced Oct 17, 2025
This was referenced Oct 18, 2025
This was referenced Oct 23, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #6596
This PR improves the XML documentation for the
IMethodSymbol.Arityproperty to provide better clarity when viewing Quick Info tooltips in IDEs.Changes
The documentation has been updated from:
To:
Rationale
The new documentation provides better clarity by:
This restructuring makes the documentation more digestible and educational for developers who may not be familiar with the term "arity".
Scope
The documentation was updated consistently across all four locations where the
Arityproperty is documented:IMethodSymbol.cs(public API interface)MethodSymbol.cs(C# compiler implementation)MethodSymbol.vb(Visual Basic compiler implementation)SynthesizedDelegateMethodSymbol.vb(Visual Basic synthesized symbols)These changes are documentation-only and do not affect any functionality or behavior of the compiler.
<issue_title>Minor quick info improvement for "Arity"</issue_title>
Fixes #6959
Original prompt
Fixes #6959
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.