remove tabs from function comments

s-mang · s-mang · commit ca00b3fd6a99 · 2022-12-16T14:31:02.000-07:00
diff --git a/doc/parse/package.go b/doc/parse/package.go
@@ -6,6 +6,7 @@ import (
 	"go/token"
 	"os"
 	"regexp"
+	"strings"
 )
 
 var (
@@ -33,6 +34,9 @@ func NewPackageDoc(dir string) (*doc.Package, error) {
 func setDocFuncsMap(pkgDoc *doc.Package) {
 	funcsMap = make(map[string]*doc.Func, len(pkgDoc.Funcs))
 	for _, fn := range pkgDoc.Funcs {
+		// replace any \t character in comment with spaces
+		// because apiary parser cannot handle tabs
+		fn.Doc = strings.Replace(fn.Doc, "\t", "    ", -1)
 		funcsMap[fn.Name] = fn
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ import (`
`6`	`6`	`"go/token"`
`7`	`7`	`"os"`
`8`	`8`	`"regexp"`
	`9`	`+ "strings"`
`9`	`10`	`)`
`10`	`11`
`11`	`12`	`var (`
`@@ -33,6 +34,9 @@ func NewPackageDoc(dir string) (*doc.Package, error) {`
`33`	`34`	`func setDocFuncsMap(pkgDoc *doc.Package) {`
`34`	`35`	`funcsMap = make(map[string]*doc.Func, len(pkgDoc.Funcs))`
`35`	`36`	`for _, fn := range pkgDoc.Funcs {`
	`37`	`+ // replace any \t character in comment with spaces`
	`38`	`+ // because apiary parser cannot handle tabs`
	`39`	`+ fn.Doc = strings.Replace(fn.Doc, "\t", " ", -1)`
`36`	`40`	`funcsMap[fn.Name] = fn`
`37`	`41`	`}`
`38`	`42`	`}`