From ea1aa765540e17043f817919febad262cf061ad8 Mon Sep 17 00:00:00 2001 From: Sean Liao Date: Sun, 14 Dec 2025 20:02:33 +0000 Subject: [PATCH] go/doc: exclude examples with results Fixes #36185 Change-Id: I7634744e62e00023367ed48a4700b61a6a6a6964 Reviewed-on: https://go-review.googlesource.com/c/go/+/729902 LUCI-TryBot-Result: Go LUCI Reviewed-by: Michael Knyszek Reviewed-by: Alan Donovan --- src/go/doc/example.go | 3 +++ src/go/doc/example_test.go | 2 ++ 2 files changed, 5 insertions(+) diff --git a/src/go/doc/example.go b/src/go/doc/example.go index ba1f863df0..8c01bf0a8d 100644 --- a/src/go/doc/example.go +++ b/src/go/doc/example.go @@ -74,6 +74,9 @@ func Examples(testFiles ...*ast.File) []*Example { if params := f.Type.Params; len(params.List) != 0 { continue // function has params; not a valid example } + if results := f.Type.Results; results != nil && len(results.List) != 0 { + continue // function has results; not a valid example + } if f.Body == nil { // ast.File.Body nil dereference (see issue 28044) continue } diff --git a/src/go/doc/example_test.go b/src/go/doc/example_test.go index 2fd54f8abb..db2b2d34cd 100644 --- a/src/go/doc/example_test.go +++ b/src/go/doc/example_test.go @@ -228,6 +228,8 @@ func ExampleFunc1_foo() {} func ExampleFunc1_foo_suffix() {} func ExampleFunc1_foo_Suffix() {} // matches Func1, instead of Func1_foo func Examplefunc1() {} // invalid - cannot match unexported +func ExampleFunc1_params(a int) {} // invalid - has parameter +func ExampleFunc1_results() int {} // invalid - has results func ExampleType1_Func1() {} func ExampleType1_Func1_() {} // invalid - suffix must start with a lower-case letter -- 2.52.0