internal/godoc/dochtml: omit "Output" section for examples with no ou…

…tput Fixes golang/go#60986
AlexanderYastrebov · Sep 23, 2023 · cd64704 · cd64704
1 parent 14233af
commit cd64704
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 1 deletion.
diff --git a/internal/godoc/dochtml/dochtml_test.go b/internal/godoc/dochtml/dochtml_test.go
@@ -178,6 +178,32 @@ func main() {
 0
 1
 </span></pre>
+</div>
+<div class="Documentation-exampleButtonsContainer">
+        <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p>
+        <button class="Documentation-exampleShareButton" aria-label="Share Code">Share</button>
+        <button class="Documentation-exampleFormatButton" aria-label="Format Code">Format</button>
+        <button class="Documentation-exampleRunButton" aria-label="Run Code">Run</button>
+      </div></details>`,
+		},
+		{
+			name:   "Example without output",
+			htmlID: "example-package-NoOutput",
+			want: `<details tabindex="-1" id="example-package-NoOutput" class="Documentation-exampleDetails js-exampleContainer">
+<summary class="Documentation-exampleDetailsHeader">Example (NoOutput) <a href="#example-package-NoOutput">¶</a></summary>
+<div class="Documentation-exampleDetailsBody">
+
+<pre class="Documentation-exampleCode">package main
+
+import (
+	&#34;fmt&#34;
+)
+
+func main() {
+	fmt.Println(&#34;hello&#34;)
+}
+</pre>
+
 </div>
 <div class="Documentation-exampleButtonsContainer">
         <p class="Documentation-exampleError" role="alert" aria-atomic="true"></p>

diff --git a/internal/godoc/dochtml/testdata/example_test.go b/internal/godoc/dochtml/testdata/example_test.go
@@ -46,3 +46,7 @@ func Example_stringsCompare() {
 	// 0
 	// 1
 }
+
+func Example_noOutput() {
+	fmt.Println("hello")
+}
diff --git a/static/doc/example.tmpl b/static/doc/example.tmpl
@@ -15,7 +15,7 @@
       <p><a class="Documentation-examplesPlay" href="{{.}}">Open in Go playground »</a></p>{{"\n" -}}
       {{- end -}}
       {{render_code .Example}}{{"\n" -}}
-      <pre><span class="Documentation-exampleOutputLabel">Output:</span>{{"\n\n"}}<span class="Documentation-exampleOutput">{{- .Output -}}</span></pre>{{"\n" -}}
+      {{- if .Output -}}<pre><span class="Documentation-exampleOutputLabel">Output:</span>{{"\n\n"}}<span class="Documentation-exampleOutput">{{- .Output -}}</span></pre>{{"\n" -}}{{- end -}}
     </div>{{"\n" -}}
     {{- if .Play -}}
       <div class="Documentation-exampleButtonsContainer">