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 <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Michael Knyszek <mknyszek@google.com>
Reviewed-by: Alan Donovan <adonovan@google.com>

diff --git a/src/go/doc/example.go b/src/go/doc/example.go
index ba1f863df0a2858ac8bed64c8f7c94de4a311261..8c01bf0a8d3507fbfa1b2b8c0ad75d202c20d309 100644 (file)
--- 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 2fd54f8abb50d3a72270b429cf5657f269357a4d..db2b2d34cd30600eb255e301f9b80ee9775ce0ab 100644 (file)
--- 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