From f96de0f7c89f643f8a1fa32ba5bdf6411c1c0082 Mon Sep 17 00:00:00 2001
From: Mohit Agarwal <mohit@sdf.org>
Date: Tue, 27 Oct 2015 00:04:38 +0530
Subject: [PATCH] x/tools/cmd/godoc: Examples should be followed by blank a
 newline

before the beginning of another function.

For example, a snippet in `godoc -ex strings` would change from

<
func Contains(s, substr string) bool
    Contains reports whether substr is within s.

    Example:
        fmt.Println(strings.Contains("seafood", "foo"))
        fmt.Println(strings.Contains("seafood", "bar"))
        fmt.Println(strings.Contains("seafood", ""))
        fmt.Println(strings.Contains("", ""))
        // Output:
        // true
        // false
        // true
        // true
func ContainsAny(s, chars string) bool
    ContainsAny reports whether any Unicode code points in chars are within
    s.

    Example:
        fmt.Println(strings.ContainsAny("team", "i"))
        fmt.Println(strings.ContainsAny("failure", "u & i"))
        fmt.Println(strings.ContainsAny("foo", ""))
        fmt.Println(strings.ContainsAny("", ""))
        // Output:
        // false
        // true
        // false
        // false
func ContainsRune(s string, r rune) bool
>

to

<
func Contains(s, substr string) bool
    Contains reports whether substr is within s.

    Example:
        fmt.Println(strings.Contains("seafood", "foo"))
        fmt.Println(strings.Contains("seafood", "bar"))
        fmt.Println(strings.Contains("seafood", ""))
        fmt.Println(strings.Contains("", ""))
        // Output:
        // true
        // false
        // true
        // true

func ContainsAny(s, chars string) bool
    ContainsAny reports whether any Unicode code points in chars are within
    s.

    Example:
        fmt.Println(strings.ContainsAny("team", "i"))
        fmt.Println(strings.ContainsAny("failure", "u & i"))
        fmt.Println(strings.ContainsAny("foo", ""))
        fmt.Println(strings.ContainsAny("", ""))
        // Output:
        // false
        // true
        // false
        // false

func ContainsRune(s string, r rune) bool
>

Fixes: golang/go#13053

Change-Id: I355870b1e90b2b6ca0104d67e85869593f294252
Reviewed-on: https://go-review.googlesource.com/16329
Reviewed-by: Andrew Gerrand <adg@golang.org>
---
 godoc/godoc.go | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/godoc/godoc.go b/godoc/godoc.go
index 0af4ef4b..dda1f49c 100644
--- a/godoc/godoc.go
+++ b/godoc/godoc.go
@@ -434,7 +434,7 @@ func (p *Presentation) example_textFunc(info *PageInfo, funcName, indent string)
 		buf.WriteString(indent)
 		buf.WriteString("Example:\n\t")
 		buf.WriteString(code)
-		buf.WriteString("\n")
+		buf.WriteString("\n\n")
 	}
 	return buf.String()
 }