fix: func name in doc strings (#1885)

Corrected the function name at the start of doc strings, as per the convention
outlined in official go documentation: https://go.dev/blog/godoc
This commit is contained in:
Yash Ladha
2022-12-26 01:38:39 +05:30
committed by GitHub
parent fdffa5a4c7
commit bf11ab6321
5 changed files with 10 additions and 10 deletions

View File

@ -48,7 +48,7 @@ func printOptionsReST(buf *bytes.Buffer, cmd *cobra.Command, name string) error
return nil
}
// linkHandler for default ReST hyperlink markup
// defaultLinkHandler for default ReST hyperlink markup
func defaultLinkHandler(name, ref string) string {
return fmt.Sprintf("`%s <%s.rst>`_", name, ref)
}
@ -169,7 +169,7 @@ func GenReSTTreeCustom(cmd *cobra.Command, dir string, filePrepender func(string
return nil
}
// adapted from: https://github.com/kr/text/blob/main/indent.go
// indentString adapted from: https://github.com/kr/text/blob/main/indent.go
func indentString(s, p string) string {
var res []byte
b := []byte(s)