Skip to content

Render display_name and signature_documentation in snapshots #391

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
jupblb merged 2 commits into from
Apr 13, 2026
Merged

Render display_name and signature_documentation in snapshots #391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa3c77e
testutil: render display_name and signature_documentation in snapshot…
jupblb Apr 10, 2026
1c5585d
testutil: indent metadata past carets in snapshot output
jupblb Apr 13, 2026
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
14 changes: 13 additions & 1 deletion bindings/go/scip/testutil/format.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ func FormatSnapshot(
b.WriteRune(' ')
b.WriteString(formatSymbol(occ.Symbol))

prefix := "\n" + commentSyntax + strings.Repeat(" ", int(pos.Start.Character))
prefix := "\n" + commentSyntax + strings.Repeat(" ", int(pos.End.Character)+1)

hasOverrideDocumentation := len(occ.OverrideDocumentation) > 0
if hasOverrideDocumentation {
Expand All @@ -147,6 +147,18 @@ func FormatSnapshot(
b.WriteString(info.Kind.String())
}

if info.DisplayName != "" {
b.WriteString(prefix)
b.WriteString("display_name ")
b.WriteString(info.DisplayName)
}

if info.SignatureDocumentation != nil && info.SignatureDocumentation.Text != "" {
b.WriteString(prefix)
b.WriteString("signature_documentation")
writeMultiline(&b, prefix, info.SignatureDocumentation.Text)
}

for _, documentation := range info.Documentation {
// At least get the first line of documentation if there is leading whitespace
documentation = strings.TrimSpace(documentation)
Expand Down
4 changes: 2 additions & 2 deletions reprolang/testdata/snapshots/output/cyclic-reference/cycle1.repro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Test cyclic references between files.
definition hello().
# ^^^^^^^^ definition cycle1.repro/hello().
# documentation
# > signature of hello().
# documentation
# > signature of hello().
reference hello().
# ^^^^^^^^ reference cycle1.repro/hello().
reference hello2().
Expand Down
4 changes: 2 additions & 2 deletions reprolang/testdata/snapshots/output/cyclic-reference/cycle2.repro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Test cyclic references between files.
definition hello2().
# ^^^^^^^^^ definition cycle2.repro/hello2().
# documentation
# > signature of hello2().
# documentation
# > signature of hello2().
reference hello().
# ^^^^^^^^ reference cycle1.repro/hello().
reference hello2().
Expand Down
12 changes: 6 additions & 6 deletions reprolang/testdata/snapshots/output/diagnostics/diagnostics.repro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
definition deprecatedMethod.
# ^^^^^^^^^^^^^^^^^ definition diagnostics.repro/deprecatedMethod.
# documentation
# > signature of deprecatedMethod.
# diagnostic Warning:
# > deprecated identifier
# documentation
# > signature of deprecatedMethod.
# diagnostic Warning:
# > deprecated identifier
reference deprecatedMethod.
# ^^^^^^^^^^^^^^^^^ reference diagnostics.repro/deprecatedMethod.
# diagnostic Warning:
# > deprecated identifier
# diagnostic Warning:
# > deprecated identifier

8 changes: 4 additions & 4 deletions reprolang/testdata/snapshots/output/duplicates/duplicate.repro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
definition readFileSync.
# ^^^^^^^^^^^^^ definition duplicate.repro/readFileSync.
# documentation
# > signature of readFileSync.
# documentation
# > signature of readFileSync.
definition readFileSync.
# ^^^^^^^^^^^^^ definition duplicate.repro/readFileSync.
# documentation
# > signature of readFileSync.
# documentation
# > signature of readFileSync.

4 changes: 2 additions & 2 deletions reprolang/testdata/snapshots/output/forward-def/forward_def.repro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# ^^^^ forward_definition forward_def.repro/abc#
definition abc#
# ^^^^ definition forward_def.repro/abc#
# documentation
# > signature of abc#
# documentation
# > signature of abc#
reference abc#
# ^^^^ reference forward_def.repro/abc#

4 changes: 2 additions & 2 deletions reprolang/testdata/snapshots/output/global-workspace/hello.repro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
definition hello().
# ^^^^^^^^ definition hello.repro/hello().
# documentation
# > signature of hello().
# documentation
# > signature of hello().
6 changes: 3 additions & 3 deletions reprolang/testdata/snapshots/output/implementation-cross-repo/bird.repro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Test how to implement a symbol from an external workspace.
definition bird# implements implementation animal.repro/animal#
# ^^^^^ definition bird.repro/bird#
# documentation
# > signature of bird#
# relationship implementation animal.repro/animal# implementation
# documentation
# > signature of bird#
# relationship implementation animal.repro/animal# implementation
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference implementation animal.repro/animal#

16 changes: 8 additions & 8 deletions reprolang/testdata/snapshots/output/implementation/animal.repro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Test how to implement a symbol within the same workspace.
definition animal#
# ^^^^^^^ definition animal.repro/animal#
# documentation
# > signature of animal#
# documentation
# > signature of animal#
definition dog# implements animal#
# ^^^^ definition animal.repro/dog#
# documentation
# > signature of dog#
# relationship animal.repro/animal# implementation
# documentation
# > signature of dog#
# relationship animal.repro/animal# implementation
# ^^^^^^^ reference animal.repro/animal#
definition cat# implements animal#
# ^^^^ definition animal.repro/cat#
# documentation
# > signature of cat#
# relationship animal.repro/animal# implementation
# documentation
# > signature of cat#
# relationship animal.repro/animal# implementation
# ^^^^^^^ reference animal.repro/animal#

8 changes: 4 additions & 4 deletions reprolang/testdata/snapshots/output/local-document/local1.repro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# docstring: local is a local method
definition local Example
# ^^^^^^^^^^^^^ definition local Example
# documentation
# > signature of Example
# documentation
# > : local is a local method
# documentation
# > signature of Example
# documentation
# > : local is a local method
reference local Example
# ^^^^^^^^^^^^^ reference local Example

4 changes: 2 additions & 2 deletions reprolang/testdata/snapshots/output/local-document/local2.repro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
definition local Example
# ^^^^^^^^^^^^^ definition local Example
# documentation
# > signature of Example
# documentation
# > signature of Example
reference local Example
# ^^^^^^^^^^^^^ reference local Example

8 changes: 4 additions & 4 deletions reprolang/testdata/snapshots/output/relationships/defined_by.repro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
definition M_f.
# ^^^^ definition defined_by.repro/M_f.
# documentation
# > signature of M_f.
# documentation
# > signature of M_f.

definition C1_f.
# ^^^^^ definition defined_by.repro/C1_f.
# documentation
# > signature of C1_f.
# documentation
# > signature of C1_f.

reference C2_f.
# ^^^^^ reference defined_by.repro/C1_f.
Expand Down
22 changes: 11 additions & 11 deletions reprolang/testdata/snapshots/output/relationships/mixed.repro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
definition local sym1
# ^^^^^^^^^^ definition local sym1
# documentation
# > signature of sym1
# documentation
# > signature of sym1
definition local sym2
# ^^^^^^^^^^ definition local sym2
# documentation
# > signature of sym2
# documentation
# > signature of sym2
definition local sym3
# ^^^^^^^^^^ definition local sym3
# documentation
# > signature of sym3
# documentation
# > signature of sym3
definition local sym4 implements local sym1 references local sym2 type_defines local sym3
# ^^^^^^^^^^ definition local sym4
# documentation
# > signature of sym4
# relationship local sym1 implementation
# relationship local sym2 reference
# relationship local sym3 type_definition
# documentation
# > signature of sym4
# relationship local sym1 implementation
# relationship local sym2 reference
# relationship local sym3 type_definition
# ^^^^^^^^^^ reference local sym1
# ^^^^^^^^^^ reference local sym2
# ^^^^^^^^^^ reference local sym3
Expand Down
10 changes: 5 additions & 5 deletions reprolang/testdata/snapshots/output/relationships/references.repro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
definition local sym1
# ^^^^^^^^^^ definition local sym1
# documentation
# > signature of sym1
# documentation
# > signature of sym1
definition local sym2 references local sym1
# ^^^^^^^^^^ definition local sym2
# documentation
# > signature of sym2
# relationship local sym1 reference
# documentation
# > signature of sym2
# relationship local sym1 reference
# ^^^^^^^^^^ reference local sym1

10 changes: 5 additions & 5 deletions reprolang/testdata/snapshots/output/relationships/type_defines.repro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
definition local sym1
# ^^^^^^^^^^ definition local sym1
# documentation
# > signature of sym1
# documentation
# > signature of sym1
definition local sym2 type_defines local sym1
# ^^^^^^^^^^ definition local sym2
# documentation
# > signature of sym2
# relationship local sym1 type_definition
# documentation
# > signature of sym2
# relationship local sym1 type_definition
# ^^^^^^^^^^ reference local sym1

Loading