From 8f10c76471156ea2165816edcd370e290f420753 Mon Sep 17 00:00:00 2001 From: Olivier Duperray Date: Mon, 11 Nov 2013 12:09:24 +1100 Subject: [PATCH] cmd/godoc: document package-level examples Fixes issue 5807 . R=golang-dev, adg CC=golang-dev https://golang.org/cl/23940043 --- src/pkg/testing/testing.go | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/pkg/testing/testing.go b/src/pkg/testing/testing.go index 5019e07626..52dc166dd9 100644 --- a/src/pkg/testing/testing.go +++ b/src/pkg/testing/testing.go @@ -73,17 +73,19 @@ // // Example functions without output comments are compiled but not executed. // -// The naming convention to declare examples for a function F, a type T and +// The naming convention to declare examples for the package, a function F, a type T and // method M on type T are: // +// func Example() { ... } // func ExampleF() { ... } // func ExampleT() { ... } // func ExampleT_M() { ... } // -// Multiple example functions for a type/function/method may be provided by +// Multiple example functions for a package/type/function/method may be provided by // appending a distinct suffix to the name. The suffix must start with a // lower-case letter. // +// func Example_suffix() { ... } // func ExampleF_suffix() { ... } // func ExampleT_suffix() { ... } // func ExampleT_M_suffix() { ... } -- 2.48.1