helpers: Rename getMmarkHtmlRenderer to getMmarkHTMLRenderer

To be consistent with the changes made in commit 67df33f, see #959.

diff --git a/helpers/content.go b/helpers/content.go
index d67514db25b77c4ad46bcfcb4ce5ea14d4d7f51a..60f885f143e2b30e7fed8bb3e573cab6d2249420 100644 (file)
--- a/helpers/content.go
+++ b/helpers/content.go
@@ -249,8 +249,8 @@ func markdownRenderWithTOC(ctx *RenderingContext) []byte {
                getMarkdownExtensions(ctx))
 }
 
-// getMmarkHtmlRenderer returns markdown html renderer.
-func getMmarkHtmlRenderer(defaultFlags int, ctx *RenderingContext) mmark.Renderer {
+// getMmarkHTMLRenderer creates a new mmark HTML Renderer with the given configuration.
+func getMmarkHTMLRenderer(defaultFlags int, ctx *RenderingContext) mmark.Renderer {
        renderParameters := mmark.HtmlRendererParameters{
                FootnoteAnchorPrefix:       viper.GetString("FootnoteAnchorPrefix"),
                FootnoteReturnLinkContents: viper.GetString("FootnoteReturnLinkContents"),
@@ -271,7 +271,6 @@ func getMmarkHtmlRenderer(defaultFlags int, ctx *RenderingContext) mmark.Rendere
        }
 }
 
-// getMmarkExtensions returns markdown extensions.
 func getMmarkExtensions(ctx *RenderingContext) int {
        flags := 0
        flags |= mmark.EXTENSION_TABLES
@@ -296,9 +295,8 @@ func getMmarkExtensions(ctx *RenderingContext) int {
        return flags
 }
 
-// mmarkRender renders markdowns.
 func mmarkRender(ctx *RenderingContext) []byte {
-       return mmark.Parse(ctx.Content, getMmarkHtmlRenderer(0, ctx),
+       return mmark.Parse(ctx.Content, getMmarkHTMLRenderer(0, ctx),
                getMmarkExtensions(ctx)).Bytes()
 }
 

diff --git a/helpers/content_renderer_test.go b/helpers/content_renderer_test.go
index f224b33e4af7625018ab397b6cbc30c611627aab..8c8e586040b25be5f781487fab09b15df00a9c7c 100644 (file)
--- a/helpers/content_renderer_test.go
+++ b/helpers/content_renderer_test.go
@@ -15,9 +15,10 @@ package helpers
 
 import (
        "bytes"
-       "github.com/spf13/viper"
        "regexp"
        "testing"
+
+       "github.com/spf13/viper"
 )
 
 // Renders a codeblock using Blackfriday
@@ -33,7 +34,7 @@ func render(input string) string {
 // Renders a codeblock using Mmark
 func renderWithMmark(input string) string {
        ctx := &RenderingContext{}
-       render := getMmarkHtmlRenderer(0, ctx)
+       render := getMmarkHTMLRenderer(0, ctx)
 
        buf := &bytes.Buffer{}
        render.BlockCode(buf, []byte(input), "html", []byte(""), false, false)

diff --git a/helpers/content_test.go b/helpers/content_test.go
index d16f1d6600709524f837789d3aa9bacc7301eafd..a89b4992e81c44d72cb45893bf594e31ff64a936 100644 (file)
--- a/helpers/content_test.go
+++ b/helpers/content_test.go
@@ -194,12 +194,12 @@ func TestGetHTMLRendererAnchors(t *testing.T) {
        }
 }
 
-func TestGetMmarkHtmlRenderer(t *testing.T) {
+func TestGetMmarkHTMLRenderer(t *testing.T) {
        ctx := &RenderingContext{}
        ctx.DocumentID = "testid"
        ctx.Config = ctx.getConfig()
        ctx.Config.PlainIDAnchors = false
-       actualRenderer := getMmarkHtmlRenderer(0, ctx)
+       actualRenderer := getMmarkHTMLRenderer(0, ctx)
 
        headerBuffer := &bytes.Buffer{}
        footnoteBuffer := &bytes.Buffer{}