Skip to content

Improve XML documentation clarity for IMethodSymbol.Arity property #80693

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

Merged
merged 3 commits into from
Oct 16, 2025
Merged

Improve XML documentation clarity for IMethodSymbol.Arity property #80693

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
84370d3
Initial plan
Copilot Oct 14, 2025
ae871df
Update Arity documentation for improved clarity
Copilot Oct 14, 2025
41d2b04
Change 'takes' to 'declares' in Arity documentation
Copilot Oct 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Compilers/CSharp/Portable/Symbols/MethodSymbol.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public abstract MethodKind MethodKind
}

/// <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.
/// A non-generic method has zero arity.
/// </summary>
public abstract int Arity { get; }
Expand Down
2 changes: 1 addition & 1 deletion src/Compilers/Core/Portable/Symbols/IMethodSymbol.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public interface IMethodSymbol : ISymbol
MethodKind MethodKind { get; }

/// <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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arity is the number of type parameters a method takes.

This phrasing is very odd/wrong. The method doesn't take type parameters. "... the number of type parameters a method declares" would make more sense

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'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"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to use "declares" instead of "takes" in commit ae871df.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

declares sounds correct to me. takes feels more informal, and we tend to try to be precise in these.

/// A non-generic method has zero arity.
/// </summary>
int Arity { get; }
Expand Down
2 changes: 1 addition & 1 deletion src/Compilers/VisualBasic/Portable/Symbols/MethodSymbol.vb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Namespace Microsoft.CodeAnalysis.VisualBasic.Symbols
End Property

''' <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.
''' A non-generic method has zero arity.
''' </summary>
Public MustOverride ReadOnly Property Arity As Integer
Expand Down
2 changes: 1 addition & 1 deletion ...pilers/VisualBasic/Portable/Symbols/SynthesizedSymbols/SynthesizedDelegateMethodSymbol.vb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Namespace Microsoft.CodeAnalysis.VisualBasic.Symbols
End Sub

''' <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.
''' A non-generic method has zero arity.
''' </summary>
Public Overrides ReadOnly Property Arity As Integer
Expand Down
Loading