filter: lua: add TODO

Author: arl

filter/lua.go

@@ -9,9 +9,6 @@ import (
 	lua "github.com/yuin/gopher-lua"
 )
 
-func ticks(s string) string         { return "`" + s + "`" }
-func startBlock(lang string) string { return "```" + lang }
-func endBlock() string              { return "```" }
 
 var luaHelp = `
 This filter runs a baker filter defined in a LUA script.
@@ -105,6 +102,13 @@ It allows to lookup a field index by its name, returning the index or nil if no
 ` + ticks("fieldNames") + ` is an integed-indexed table, in other words an array, containing all field names, as ` + ticks("FieldNames") + ` in Go.
 `
 
+// TODO(arl): ideally this functions should not be required, but writing
+// markdown documentation in Go strings is tedious and error-prone.
+
+func ticks(s string) string         { return "`" + s + "`" }
+func startBlock(lang string) string { return "```" + lang }
+func endBlock() string              { return "```" }
+
 // LUADesc describes the LUA filter
 var LUADesc = baker.FilterDesc{
 	Name:   "LUA",