internal/fetch/dochtml: only show function pointer names in side nav
When generating shortened function signatures for display in the side
navigation UI component, don’t recursively render the types for
arguments that are function pointers. This matches the behavior for
arguments that aren’t function pointers, and it also just looks better.
Example: func (mx *Mux) Group(fn func(r Router)) Router
Before: (mx) Group(fnfunc(r))
After: (mx) Group(fn)
Fixes golang/go#41486
Change-Id: I9a5198a20ae1be41da7a73c3ef8ef950469d91ea
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/256580
Reviewed-by: Julie Qiu <julie@golang.org>
Trust: Jonathan Amsterdam <jba@google.com>
Trust: Julie Qiu <julie@golang.org>
diff --git a/internal/fetch/dochtml/internal/render/short_synopsis.go b/internal/fetch/dochtml/internal/render/short_synopsis.go
index e364cd9..5e62d4d 100644
--- a/internal/fetch/dochtml/internal/render/short_synopsis.go
+++ b/internal/fetch/dochtml/internal/render/short_synopsis.go
@@ -81,9 +81,5 @@
for _, name := range field.Names {
names = append(names, name.Name)
}
- s, err := shortOneLineNodeDepth(fset, field.Type, depth)
- if err != nil {
- return "", err
- }
- return joinStrings(names) + s, nil
+ return joinStrings(names), nil
}
diff --git a/internal/fetch/dochtml/internal/render/short_synopsis_test.go b/internal/fetch/dochtml/internal/render/short_synopsis_test.go
index 2e6a2a3..e53e44d 100644
--- a/internal/fetch/dochtml/internal/render/short_synopsis_test.go
+++ b/internal/fetch/dochtml/internal/render/short_synopsis_test.go
@@ -35,6 +35,8 @@
func NArgs(a, b string) (a, b string) { return }
+ func (mx *Mux) Issue41486(fn func(r Router)) Router { return }
+
type t struct{}`
want := []struct {
@@ -46,6 +48,7 @@
{result: `(s) Method()`},
{result: `NewStruct2()`},
{result: `NArgs(a, b)`},
+ {result: `(mx) Issue41486(fn)`},
{err: true},
}
