Merge pull request #16 from cespare/blockcodegithub_doc_fix

Fix up method documentation formatting for the BlockCodeGithub method.
This commit is contained in:
Russ Ross 2012-11-22 18:00:19 -08:00
commit 3c0965e698

34
html.go
View File

@ -216,24 +216,22 @@ func (options *Html) BlockCodeNormal(out *bytes.Buffer, text []byte, lang string
out.WriteString("</code></pre>\n") out.WriteString("</code></pre>\n")
} }
/* // GitHub style code block:
* GitHub style code block: //
* // <pre lang="LANG"><code>
* <pre lang="LANG"><code> // ...
* ... // </code></pre>
* </pre></code> //
* // Unlike other parsers, we store the language identifier in the <pre>,
* Unlike other parsers, we store the language identifier in the <pre>, // and don't let the user generate custom classes.
* and don't let the user generate custom classes. //
* // The language identifier in the <pre> block gets postprocessed and all
* The language identifier in the <pre> block gets postprocessed and all // the code inside gets syntax highlighted with Pygments. This is much safer
* the code inside gets syntax highlighted with Pygments. This is much safer // than letting the user specify a CSS class for highlighting.
* than letting the user specify a CSS class for highlighting. //
* // Note that we only generate HTML for the first specifier.
* Note that we only generate HTML for the first specifier. // E.g.
* E.g. // ~~~~ {.python .numbered} => <pre lang="python"><code>
* ~~~~ {.python .numbered} => <pre lang="python"><code>
*/
func (options *Html) BlockCodeGithub(out *bytes.Buffer, text []byte, lang string) { func (options *Html) BlockCodeGithub(out *bytes.Buffer, text []byte, lang string) {
doubleSpace(out) doubleSpace(out)