Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Oct 14, 2025

Fixes #6596

This PR improves the XML documentation for the IMethodSymbol.Arity property to provide better clarity when viewing Quick Info tooltips in IDEs.

Changes

The documentation has been updated from:

Returns the arity of this method, or the number of type parameters it takes. A non-generic method has zero arity.

To:

Returns the arity of this method. Arity is the number of type parameters a method takes. A non-generic method has zero arity.

Rationale

The new documentation provides better clarity by:

  1. First stating what the property returns
  2. Then providing an explicit definition of "arity" as a concept
  3. Maintaining the clarification about non-generic methods

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 Arity property 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.

Original prompt

This section details on the original issue you should resolve

<issue_title>Minor quick info improvement for "Arity"</issue_title>
<issue_description>image

The quick info documentation for "Arity" (which is already great) can be improved slightly. My suggestion - Returns the arity of this method. Arity is the number of type parameters a method takes. A non-generic method has zero arity.
</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #6959


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@Copilot Copilot AI changed the title [WIP] Improve quick info documentation for Arity Improve XML documentation clarity for IMethodSymbol.Arity property Oct 14, 2025
@Copilot Copilot AI requested a review from CyrusNajmabadi October 14, 2025 10:12
Copilot finished work on behalf of CyrusNajmabadi October 14, 2025 10:12
@CyrusNajmabadi CyrusNajmabadi marked this pull request as ready for review October 15, 2025 10:57
@CyrusNajmabadi CyrusNajmabadi requested a review from a team as a code owner October 15, 2025 10:57
@CyrusNajmabadi
Copy link
Member

@dotnet/roslyn-compiler ptal.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Minor quick info improvement for "Arity"

3 participants