Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Fix up method documentation formatting for the BlockCodeGithub method. #16

Merged
merged 2 commits into from

2 participants

Caleb Spare Russ Ross
Caleb Spare

Java-style comment banners-of-stars don't work with go docs (either in godoc or go.pkgdoc.org).

Russ Ross russross merged commit 3c0965e into from
Russ Ross
Owner

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.
Showing with 16 additions and 18 deletions.
  1. +16 −18 html.go
34 html.go
View
@@ -216,24 +216,22 @@ func (options *Html) BlockCodeNormal(out *bytes.Buffer, text []byte, lang string
out.WriteString("</code></pre>\n")
}
-/*
- * GitHub style code block:
- *
- * <pre lang="LANG"><code>
- * ...
- * </pre></code>
- *
- * Unlike other parsers, we store the language identifier in the <pre>,
- * and don't let the user generate custom classes.
- *
- * The language identifier in the <pre> block gets postprocessed and all
- * the code inside gets syntax highlighted with Pygments. This is much safer
- * than letting the user specify a CSS class for highlighting.
- *
- * Note that we only generate HTML for the first specifier.
- * E.g.
- * ~~~~ {.python .numbered} => <pre lang="python"><code>
- */
+// GitHub style code block:
+//
+// <pre lang="LANG"><code>
+// ...
+// </code></pre>
+//
+// Unlike other parsers, we store the language identifier in the <pre>,
+// and don't let the user generate custom classes.
+//
+// The language identifier in the <pre> block gets postprocessed and all
+// the code inside gets syntax highlighted with Pygments. This is much safer
+// than letting the user specify a CSS class for highlighting.
+//
+// Note that we only generate HTML for the first specifier.
+// E.g.
+// ~~~~ {.python .numbered} => <pre lang="python"><code>
func (options *Html) BlockCodeGithub(out *bytes.Buffer, text []byte, lang string) {
doubleSpace(out)
Something went wrong with that request. Please try again.