From b05a292c218aeb1e21fc5fee2e94437b09cb977b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Fri, 7 Aug 2015 20:09:40 +0200 Subject: [PATCH] Revert "Fix some Go code doc issues" This reverts commit de7dd70bbc1ac533f137e5f788e1b337d6ba6b8c. Broke the code fence feat. --- commands/undraft.go | 8 ++++---- helpers/content.go | 8 +++++--- helpers/content_renderer.go | 6 +++--- helpers/path.go | 1 - 4 files changed, 12 insertions(+), 11 deletions(-) diff --git a/commands/undraft.go b/commands/undraft.go index 9ec33b13a..f10728d82 100644 --- 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, } -// Undraft publishes the specified content by setting its draft status +// Publish 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 11e2755d3..8e3fda505 100644 --- 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 Blackfriday Renderer with the given configuration. +// GetHtmlRenderer creates a new Renderer with the given configuration. func GetHTMLRenderer(defaultFlags int, ctx *RenderingContext) blackfriday.Renderer { renderParameters := blackfriday.HtmlRendererParameters{ FootnoteAnchorPrefix: viper.GetString("FootnoteAnchorPrefix"), @@ -172,11 +172,12 @@ 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 | @@ -208,7 +209,7 @@ func markdownRenderWithTOC(ctx *RenderingContext) []byte { getMarkdownExtensions(ctx)) } -// GetMmarkHtmlRenderer creates a new MMark Renderer with the given configuration. +// mmark func GetMmarkHtmlRenderer(defaultFlags int, ctx *RenderingContext) mmark.Renderer { renderParameters := mmark.HtmlRendererParameters{ FootnoteAnchorPrefix: viper.GetString("FootnoteAnchorPrefix"), @@ -219,6 +220,7 @@ 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 5f26963a1..bb5b810ae 100644 --- a/helpers/content_renderer.go +++ b/helpers/content_renderer.go @@ -8,12 +8,12 @@ import ( "github.com/spf13/viper" ) -// hugoHtmlRenderer wraps a blackfriday.Renderer, typically a blackfriday.Html -type hugoHtmlRenderer struct { +// 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 ce2005715..ba6d0e9d1 100644 --- a/helpers/path.go +++ b/helpers/path.go @@ -85,7 +85,6 @@ 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) }