From 08d63d3a7d9777a04d65e69255ed46de8d2b2a9c Mon Sep 17 00:00:00 2001 From: CodeLingo Bot Date: Wed, 13 Feb 2019 00:50:56 +0000 Subject: [PATCH] Fix function comments based on best practices from Effective Go Signed-off-by: CodeLingo Bot --- latex.go | 4 ++-- markdown.go | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/latex.go b/latex.go index 3d30d094..12e30321 100644 --- a/latex.go +++ b/latex.go @@ -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") diff --git a/markdown.go b/markdown.go index 41595d62..dc481c53 100644 --- a/markdown.go +++ b/markdown.go @@ -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: //