Fix function comments based on best practices from Effective Go

Signed-off-by: CodeLingo Bot <bot@codelingo.io>
This commit is contained in:
CodeLingo Bot 2019-02-13 00:50:56 +00:00
parent a477dd1646
commit 08d63d3a7d
2 changed files with 3 additions and 3 deletions

View File

@ -39,7 +39,7 @@ func (options *Latex) GetFlags() int {
return 0
}
// render code chunks using verbatim, or listings if we have a language
// BlockCode renders code chunks using verbatim, or listings if we have a language
func (options *Latex) BlockCode(out *bytes.Buffer, text []byte, info string) {
if info == "" {
out.WriteString("\n\\begin{verbatim}\n")
@ -299,7 +299,7 @@ func (options *Latex) NormalText(out *bytes.Buffer, text []byte) {
escapeSpecialChars(out, text)
}
// header and footer
// DocumentHeader: header and footer
func (options *Latex) DocumentHeader(out *bytes.Buffer) {
out.WriteString("\\documentclass{article}\n")
out.WriteString("\n")

View File

@ -306,7 +306,7 @@ func MarkdownBasic(input []byte) []byte {
return MarkdownOptions(input, renderer, Options{Extensions: 0})
}
// Call Markdown with most useful extensions enabled
// MarkdownCommon: Call Markdown with most useful extensions enabled
// MarkdownCommon is a convenience function for simple rendering.
// It processes markdown input with common extensions enabled, including:
//