DOCSP-26295: Adds annotations for more than one example (#26)

Author: sarahsimpers

cobra2snooty.go

@@ -72,12 +72,6 @@ const syntaxHeader = `Syntax
 .. code-block::
 `
 
-const examplesHeader = `Examples
---------
-
-.. code-block::
-`
-
 const tocHeader = `
 .. toctree::
    :titlesonly:
@@ -119,9 +113,8 @@ func GenDocs(cmd *cobra.Command, w io.Writer) error {
 	}
 	printOptions(buf, cmd)
 
-	if len(cmd.Example) > 0 {
-		buf.WriteString(examplesHeader)
-		buf.WriteString(fmt.Sprintf("\n%s\n\n", indentString(cmd.Example, " ")))
+	if cmd.Example != "" {
+		printExamples(buf, cmd)
 	}
 
 	if hasRelatedCommands(cmd) {

cobra2snooty_test.go

@@ -71,7 +71,7 @@ func Echo() *cobra.Command {
 		Aliases: []string{"say"},
 		Short:   "Echo anything to the screen",
 		Long:    "an utterly useless command for testing",
-		Example: "Just run root echo",
+		Example: " # Example with intro text\n  atlas command no intro text\n",
 		Annotations: map[string]string{
 			"string to printDesc": "A string to print",
 			"test paramDesc":      "just for testing",
@@ -129,7 +129,11 @@ func TestGenDocs(t *testing.T) {
 	output := buf.String()
 
 	checkStringContains(t, output, Echo().Long)
-	checkStringContains(t, output, Echo().Example)
+	checkStringContains(t, output, `.. code-block::
+
+   # Example with intro text
+   atlas command no intro text
+`)
 	checkStringContains(t, output, "boolone")
 	checkStringContains(t, output, "rootflag")
 	//
@@ -154,7 +158,11 @@ func TestGenDocsNoHiddenParents(t *testing.T) {
 	output := buf.String()
 
 	checkStringContains(t, output, Echo().Long)
-	checkStringContains(t, output, Echo().Example)
+	checkStringContains(t, output, `.. code-block::
+
+   # Example with intro text
+   atlas command no intro text
+`)
 	checkStringContains(t, output, "boolone")
 	checkStringOmits(t, output, "rootflag")
 	checkStringOmits(t, output, Root().Short)

examples.go

@@ -0,0 +1,48 @@
+// Copyright 2022 MongoDB Inc
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package cobra2snooty
+
+import (
+	"bytes"
+	"fmt"
+	"strings"
+
+	"github.com/spf13/cobra"
+)
+
+const (
+	examplesHeader = `Examples
+--------
+
+`
+	identChar = " "
+)
+
+func printExamples(buf *bytes.Buffer, cmd *cobra.Command) {
+	// Create example substrings
+	examplestrimmed := strings.TrimLeft(cmd.Example, " #")
+	examples := strings.Split(examplestrimmed, "# ")
+	buf.WriteString(examplesHeader)
+	// If it has an example, print the header, then print each in a code block.
+	for _, example := range examples[0:] {
+		comment := ""
+		if strings.Contains(cmd.Example, "#") {
+			comment = "#"
+		}
+		buf.WriteString(`.. code-block::
+`)
+		buf.WriteString(fmt.Sprintf("\n   %s%s\n", comment, indentString(example, identChar)))
+	}
+}