fix(internal/godocfx): replace * with HTML code (#5049)

Sometimes, the DocFX Markdown interpreter interprets * as <em>.
googleapis · Nov 1, 2021 · a8f7c06 · a8f7c06
1 parent 6d07eca
commit a8f7c06
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/internal/godocfx/parse.go b/internal/godocfx/parse.go
@@ -625,7 +625,11 @@ func toHTML(s string) string {
 		panic(err)
 	}
 
-	return mdBuf.String()
+	// Replace * with &#42; to avoid confusing the DocFX Markdown processor,
+	// which sometimes interprets * as <em>.
+	result := string(bytes.ReplaceAll(mdBuf.Bytes(), []byte("*"), []byte("&#42;")))
+
+	return result
 }
 
 func hasPrefix(s string, prefixes []string) bool {

diff --git a/internal/godocfx/testdata/golden/index.yml b/internal/godocfx/testdata/golden/index.yml
@@ -91,7 +91,7 @@ items:
     client are often of the type <a href=\"https://godoc.org/google.golang.org/api/googleapi#Error\"><code>googleapi.Error</code></a>.\nThese
     errors can be introspected for more information by type asserting to the richer
     <code>googleapi.Error</code> type. For example:</p>\n<pre class=\"prettyprint\"><code>if
-    e, ok := err.(*googleapi.Error); ok {\n\t  if e.Code == 409 { ... }\n}\n</code></pre>"
+    e, ok := err.(&#42;googleapi.Error); ok {\n\t  if e.Code == 409 { ... }\n}\n</code></pre>"
   type: package
   langs:
   - go