Fix some Go code doc issues

diff --git a/commands/undraft.go b/commands/undraft.go
index f10728d82da41984f4664e25aa6e718570bd60e7..9ec33b13aa31477623f82d05445b9b23c906215f 100644 (file)
--- a/commands/undraft.go
+++ b/commands/undraft.go
@@ -26,13 +26,13 @@ import (
 var undraftCmd = &cobra.Command{
        Use:   "undraft path/to/content",
        Short: "Undraft changes the content's draft status from 'True' to 'False'",
-       Long:  `Undraft changes the content's draft status from 'True' to 'False'
-and updates the date to the current date and time.
+       Long: `Undraft changes the content's draft status from 'True' to 'False'
+and updates the date to/ the current date and time.
 If the content's draft status is 'False', nothing is done.`,
-       Run:   Undraft,
+       Run: Undraft,
 }
 
-// Publish publishes the specified content by setting its draft status
+// Undraft publishes the specified content by setting its draft status
 // to false and setting its publish date to now. If the specified content is
 // not a draft, it will log an error.
 func Undraft(cmd *cobra.Command, args []string) {

diff --git a/helpers/content.go b/helpers/content.go
index 8e3fda5053d7e8d2bac05ece3ac8506838678b1c..11e2755d3843058b56a6c903bb24422810e308be 100644 (file)
--- a/helpers/content.go
+++ b/helpers/content.go
@@ -134,7 +134,7 @@ func BytesToHTML(b []byte) template.HTML {
        return template.HTML(string(b))
 }
 
-// GetHtmlRenderer creates a new Renderer with the given configuration.
+// GetHTMLRenderer creates a new Blackfriday Renderer with the given configuration.
 func GetHTMLRenderer(defaultFlags int, ctx *RenderingContext) blackfriday.Renderer {
        renderParameters := blackfriday.HtmlRendererParameters{
                FootnoteAnchorPrefix:       viper.GetString("FootnoteAnchorPrefix"),
@@ -172,12 +172,11 @@ func GetHTMLRenderer(defaultFlags int, ctx *RenderingContext) blackfriday.Render
                htmlFlags |= blackfriday.HTML_SMARTYPANTS_LATEX_DASHES
        }
 
-       return &HugoHtmlRenderer{
+       return &hugoHtmlRenderer{
                blackfriday.HtmlRendererWithParameters(htmlFlags, "", "", renderParameters),
        }
 }
 
-
 func getMarkdownExtensions(ctx *RenderingContext) int {
        flags := 0 | blackfriday.EXTENSION_NO_INTRA_EMPHASIS |
                blackfriday.EXTENSION_TABLES | blackfriday.EXTENSION_FENCED_CODE |
@@ -209,7 +208,7 @@ func markdownRenderWithTOC(ctx *RenderingContext) []byte {
                getMarkdownExtensions(ctx))
 }
 
-// mmark
+// GetMmarkHtmlRenderer creates a new MMark Renderer with the given configuration.
 func GetMmarkHtmlRenderer(defaultFlags int, ctx *RenderingContext) mmark.Renderer {
        renderParameters := mmark.HtmlRendererParameters{
                FootnoteAnchorPrefix:       viper.GetString("FootnoteAnchorPrefix"),
@@ -220,7 +219,6 @@ func GetMmarkHtmlRenderer(defaultFlags int, ctx *RenderingContext) mmark.Rendere
 
        if b && !ctx.getConfig().PlainIDAnchors {
                renderParameters.FootnoteAnchorPrefix = ctx.DocumentID + ":" + renderParameters.FootnoteAnchorPrefix
-               // renderParameters.HeaderIDSuffix = ":" + ctx.DocumentId
        }
 
        htmlFlags := defaultFlags

diff --git a/helpers/content_renderer.go b/helpers/content_renderer.go
index bb5b810aeb586b8845a1584b3dcc0327458aeb22..5f26963a1e2aae733db283c17b6b21da63079d31 100644 (file)
--- a/helpers/content_renderer.go
+++ b/helpers/content_renderer.go
@@ -8,12 +8,12 @@ import (
        "github.com/spf13/viper"
 )
 
-// Wraps a blackfriday.Renderer, typically a blackfriday.Html
-type HugoHtmlRenderer struct {
+// hugoHtmlRenderer wraps a blackfriday.Renderer, typically a blackfriday.Html
+type hugoHtmlRenderer struct {
        blackfriday.Renderer
 }
 
-func (renderer *HugoHtmlRenderer) BlockCode(out *bytes.Buffer, text []byte, lang string) {
+func (renderer *hugoHtmlRenderer) blockCode(out *bytes.Buffer, text []byte, lang string) {
        if viper.GetBool("PygmentsCodeFences") {
                str := html.UnescapeString(string(text))
                out.WriteString(Highlight(str, lang, ""))

diff --git a/helpers/path.go b/helpers/path.go
index ba6d0e9d1a8fcbabe584cc47ede7cbc02f18dea3..ce20057156c89e3139cbf3874be99d2cb12a69f7 100644 (file)
--- a/helpers/path.go
+++ b/helpers/path.go
@@ -85,6 +85,7 @@ func MakePathToLower(s string) string {
        return strings.ToLower(MakePath(s))
 }
 
+// MakeTitle trims any space and replaces hypens with a single space.
 func MakeTitle(inpath string) string {
        return strings.Replace(strings.TrimSpace(inpath), "-", " ", -1)
 }