Update documentation for DeclaringSyntaxReferences and Locations to clarify partial members behavior #80704

Copilot · 2025-10-14T14:12:19Z

Documentation Update for DeclaringSyntaxReferences and Locations

Progress

Understand the current behavior of DeclaringSyntaxReferences and Locations for partial methods
Update documentation for ISymbol.Locations to clarify behavior for partial types vs partial members
Update documentation for ISymbol.DeclaringSyntaxReferences to clarify behavior for partial types vs partial members
Create test to document the expected behavior
Build and validate the changes
Address code review feedback to be more explicit about partial types
Address review comments: fix issue link, simplify test, update instructions

Changes Made

Documentation Updates in `ISymbol.cs`

Locations property: Updated documentation to clarify that:
- Partial types (classes, structs, and interfaces) return multiple locations
- Partial members (methods, properties, events) return only ONE location
- To get all locations for partial members, use PartialDefinitionPart and PartialImplementationPart properties
DeclaringSyntaxReferences property: Updated documentation with the same clarifications

Test Added

Added PartialMethodsLocationsAndSyntaxReferences test in MethodTests.cs that:

Verifies that partial methods only have 1 location in Locations array
Verifies that partial methods only have 1 reference in DeclaringSyntaxReferences array
Documents how to get all locations using PartialImplementationPart
Links to the correct issue Provide better API and documentation for SyntaxReferences of partial methods #22598

Instructions Updated

Updated .github/instructions/Compiler.instructions.md to guide future tests to be focused and avoid unnecessary assertions.

Build Status

✅ All builds passed
✅ All existing tests passed
✅ New test passed
✅ Code review feedback addressed

💡 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.

…larify partial members behavior Co-authored-by: CyrusNajmabadi <[email protected]>

Co-authored-by: CyrusNajmabadi <[email protected]>

CyrusNajmabadi · 2025-10-14T15:30:11Z

@dotnet/roslyn-compiler ptal.

jcouv · 2025-10-14T16:53:03Z

I don't understand why this PR didn't automatically get labelled with "Compiler" given that it touches a compiler file. Is there a bot problem?
The way to get compiler reviews is to add this label.

CyrusNajmabadi · 2025-10-15T11:00:26Z

@dotnet/roslyn-compiler ptal.

jcouv · 2025-10-15T16:47:34Z

src/Compilers/CSharp/Test/Symbol/Symbols/Source/MethodTests.cs

+        [Fact, WorkItem("https://github.com/dotnet/roslyn/issues/13456")]
+        public void PartialMethodsLocationsAndSyntaxReferences()
+        {
+            // This test documents the behavior described in https://github.com/dotnet/roslyn/issues/13456


Link is wrong #Closed

jcouv · 2025-10-15T16:48:52Z

src/Compilers/CSharp/Test/Symbol/Symbols/Source/MethodTests.cs

+    }
+}";
+
+            var comp = CreateCompilation(new[] { source, source2 });


nit: it looks like copilot doesn't know about collection expressions yet. Maybe something we can nudge via repo-level instructions? #Closed

jcouv · 2025-10-15T16:51:26Z

src/Compilers/CSharp/Test/Symbol/Symbols/Source/MethodTests.cs

+            var comp = CreateCompilation(new[] { source, source2 });
+            comp.VerifyDiagnostics();
+
+            var methodSymbols = comp.GetSymbolsWithName("PartialM");


This is unnecessary lengthy and complicated. Since we know there's only one and it's a method symbol: we can do 1 line, var method = (IMethodSymbol)comp.GetSymbolsWithName("PartialM").Single();, instead of 5 lines #Closed

@copilot remove lengthy and complicated assertion checking. Also add to the copilot-instructions file that tests should avoid unnecessary assertations and should do the minimal work necessary to get to the core assertions that validate the issue being addressed.

Simplified test and updated Compiler.instructions.md to guide future tests in commit 2c7c5d9

jcouv · 2025-10-15T16:53:10Z

src/Compilers/CSharp/Test/Symbol/Symbols/Source/MethodTests.cs

+            Assert.Equal(1, implementationPart.DeclaringSyntaxReferences.Length);
+
+            // Verify the locations are different
+            Assert.NotEqual(method.Locations[0], implementationPart.Locations[0]);


By naming the sources when creating the compilation (CreateCompilation([(source, "source"), (source2, "source2")])) it should be easy to observe each location #Closed

jcouv · 2025-10-15T16:54:07Z

Fixes #13456

The link in OP is hallucinated #Closed

jcouv

Done with review pass (commit 3)

CyrusNajmabadi · 2025-10-20T17:31:16Z

@dotnet/roslyn-compiler ptal.

jcouv · 2025-10-20T19:06:46Z

src/Compilers/CSharp/Test/Symbol/Symbols/Source/MethodTests.cs

            Assert.False(partialImplConstructed.IsPartialDefinition);
        }
+
+        [Fact, WorkItem("https://github.com/dotnet/roslyn/issues/13456")]


Link is wrong here too #Closed

jcouv · 2025-10-20T19:07:31Z

src/Compilers/CSharp/Test/Symbol/Symbols/Source/MethodTests.cs

+            var methodSymbols = comp.GetSymbolsWithName("PartialM");
+
+            var method = (IMethodSymbol)methodSymbols.Single();
+            Assert.NotNull(method);


Unnecessary assertion #Closed

Removed in commit 2c7c5d9

jcouv · 2025-10-20T19:07:56Z

src/Compilers/CSharp/Test/Symbol/Symbols/Source/MethodTests.cs

+            var comp = CreateCompilation([(source1, "source1"), (source2, "source2")]);
+            comp.VerifyDiagnostics();
+
+            var methodSymbols = comp.GetSymbolsWithName("PartialM");


Consider inlining methodSymbols since only used once #Closed

Inlined in commit 2c7c5d9

jcouv

Done with review pass (commit 5)

src/Compilers/CSharp/Test/Symbol/Symbols/Source/MethodTests.cs

…ion, inline variable, and update instructions Co-authored-by: CyrusNajmabadi <[email protected]>

src/Compilers/Core/Portable/Symbols/ISymbol.cs

Co-authored-by: Rikki Gibson <[email protected]>

jcouv

LGTM Thanks (commit 8)

* upstream/main: (123 commits) Fix SafeContext of Span-valued collection expressions to match specification (dotnet#80684) Improve detection of invalid references for implicitly typed expression variables declared within implicit object creation expressions. (dotnet#80546) Add test demonstrating behavior of ToMinimalDisplayString. (dotnet#80757) Only set DOTNET_HOST_PATH if something was installed (dotnet#80842) Clean up a Razor external access service (dotnet#80830) Remove unused statement (dotnet#80823) Allow foreach on typed null enumerables (dotnet#80783) Update documentation for DeclaringSyntaxReferences and Locations to clarify partial members behavior (dotnet#80704) Fix issue converting an auto prop to a full prop when 'field' and 'initializers' are involved Rename childIsSimple to innerExpressionHasPrimaryPrecedence and add more test cases Remove placeholder WorkItem attributes from new tests Fix RemoveUnnecessaryParentheses to detect simple expressions in bitwise operations [main] Update dependencies from dotnet/arcade (dotnet#80828) Fix ITypeSymbol.BaseType documentation for type parameters (dotnet#80770) soft-select select camelcase matched item if user might be typing an undefined type parameter (dotnet#80809) Allow semantic tokens in Razor to be better behaved (dotnet#80815) Rebase Remove using Update test Add fix all test ...

Initial plan

d1ffbbf

Copilot AI assigned Copilot and CyrusNajmabadi Oct 14, 2025

Copilot started work on behalf of CyrusNajmabadi October 14, 2025 14:12 View session

Copilot AI and others added 2 commits October 14, 2025 14:26

Update documentation for DeclaringSyntaxReferences and Locations to c…

86b9a8e

…larify partial members behavior Co-authored-by: CyrusNajmabadi <[email protected]>

Make documentation more explicit about partial types

7cf70f9

Co-authored-by: CyrusNajmabadi <[email protected]>

Copilot AI changed the title ~~[WIP] Provide better API and documentation for SyntaxReferences~~ Update documentation for DeclaringSyntaxReferences and Locations to clarify partial members behavior Oct 14, 2025

Copilot AI requested a review from CyrusNajmabadi October 14, 2025 14:33

Copilot finished work on behalf of CyrusNajmabadi October 14, 2025 14:33

CyrusNajmabadi approved these changes Oct 14, 2025

View reviewed changes

CyrusNajmabadi marked this pull request as ready for review October 14, 2025 14:40

CyrusNajmabadi requested a review from a team as a code owner October 14, 2025 14:40

jcouv added the Area-Compilers label Oct 14, 2025

jcouv reviewed Oct 15, 2025

View reviewed changes

jcouv added Documentation Test Test failures in roslyn-CI labels Oct 15, 2025

jcouv self-assigned this Oct 15, 2025

jcouv reviewed Oct 15, 2025

View reviewed changes

CyrusNajmabadi added 2 commits October 15, 2025 19:22

Simplify

f7560e5

Simplify test

a2577d2

CyrusNajmabadi requested a review from jcouv October 20, 2025 17:31

jcouv reviewed Oct 20, 2025

View reviewed changes

CyrusNajmabadi reviewed Oct 20, 2025

View reviewed changes

src/Compilers/CSharp/Test/Symbol/Symbols/Source/MethodTests.cs Outdated Show resolved Hide resolved

Update src/Compilers/CSharp/Test/Symbol/Symbols/Source/MethodTests.cs

0c0af75

Copilot started work on behalf of CyrusNajmabadi October 20, 2025 21:00 View session

Address review feedback: fix WorkItem link, remove unnecessary assert…

dc7f595

…ion, inline variable, and update instructions Co-authored-by: CyrusNajmabadi <[email protected]>

Copilot AI requested a review from a team as a code owner October 20, 2025 21:05

Copilot AI requested a review from CyrusNajmabadi October 20, 2025 21:06

Copilot finished work on behalf of CyrusNajmabadi October 20, 2025 21:06

RikkiGibson reviewed Oct 21, 2025

View reviewed changes

src/Compilers/Core/Portable/Symbols/ISymbol.cs Outdated Show resolved Hide resolved

RikkiGibson approved these changes Oct 21, 2025

View reviewed changes

Update src/Compilers/Core/Portable/Symbols/ISymbol.cs

d93ff58

Co-authored-by: Rikki Gibson <[email protected]>

jcouv approved these changes Oct 21, 2025

View reviewed changes

CyrusNajmabadi merged commit 53766eb into main Oct 21, 2025
24 checks passed

CyrusNajmabadi deleted the copilot/improve-api-documentation branch October 21, 2025 17:56

dotnet-policy-service bot added this to the Next milestone Oct 21, 2025

CyrusNajmabadi mentioned this pull request Oct 21, 2025

Provide better API and documentation for SyntaxReferences of partial methods #22598

Closed

dotnet-maestro bot mentioned this pull request Oct 23, 2025

[main] Source code updates from dotnet/roslyn dotnet/dotnet#3061

Closed

This was referenced Oct 25, 2025

[Automated] PRs inserted in VS build feature.polytype-11124.148 #80896

Closed

[Automated] PRs inserted in VS build main-11124.32 #80897

Closed

[Automated] PRs inserted in VS build feature.debugger.main-11127.165 #80926

Closed

dotnet-maestro bot mentioned this pull request Oct 29, 2025

[main] Source code updates from dotnet/roslyn dotnet/dotnet#3147

Open

Update documentation for DeclaringSyntaxReferences and Locations to clarify partial members behavior #80704

Update documentation for DeclaringSyntaxReferences and Locations to clarify partial members behavior #80704

Uh oh!

Conversation

Copilot AI commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation Update for DeclaringSyntaxReferences and Locations

Progress

Changes Made

Documentation Updates in ISymbol.cs

Test Added

Instructions Updated

Build Status

Uh oh!

CyrusNajmabadi commented Oct 14, 2025

Uh oh!

jcouv commented Oct 14, 2025

Uh oh!

CyrusNajmabadi commented Oct 15, 2025

Uh oh!

jcouv Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jcouv Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jcouv Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CyrusNajmabadi Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

jcouv Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jcouv commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jcouv left a comment

Choose a reason for hiding this comment

Uh oh!

CyrusNajmabadi commented Oct 20, 2025

Uh oh!

jcouv Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jcouv Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

jcouv Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

jcouv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jcouv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Copilot AI commented Oct 14, 2025 •

edited

Loading

Documentation Updates in `ISymbol.cs`

jcouv Oct 15, 2025 •

edited

Loading

jcouv Oct 15, 2025 •

edited

Loading

jcouv Oct 15, 2025 •

edited

Loading

jcouv Oct 15, 2025 •

edited

Loading

jcouv commented Oct 15, 2025 •

edited

Loading

jcouv Oct 20, 2025 •

edited

Loading

jcouv Oct 20, 2025 •

edited

Loading

jcouv Oct 20, 2025 •

edited

Loading