Skip to content

Add the ability to customize the example_text function #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
aerostitch wants to merge 1 commit into from
Closed

Add the ability to customize the example_text function #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion godoc/godoc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ func (p *Presentation) initFuncMap() {
// formatting of Examples
"example_html": p.example_htmlFunc,
"example_text": p.example_textFunc,
"example_text2": p.example_text2Func,
"example_name": p.example_nameFunc,
"example_suffix": p.example_suffixFunc,

Expand Down Expand Up @@ -588,6 +589,10 @@ func docLinkFunc(s string, ident string) string {
}

func (p *Presentation) example_textFunc(info *PageInfo, funcName, indent string) string {
return example_text2Func(info, funcName, indent, "Example:", "", "")
}

func (p *Presentation) example_text2Func(info *PageInfo, funcName, indent, title, codePrefix, codeSuffix string) string {
if !p.ShowExamples {
return ""
}
Expand Down Expand Up @@ -624,8 +629,13 @@ func (p *Presentation) example_textFunc(info *PageInfo, funcName, indent string)
code = strings.Trim(code, "\n")

buf.WriteString(indent)
buf.WriteString("Example:\n")
buf.WriteString(title)
buf.WriteString("\n")
buf.WriteString(codePrefix)
buf.WriteString("\n")
buf.WriteString(code)
buf.WriteString("\n")
buf.WriteString(codeSuffix)
buf.WriteString("\n\n")
}
return buf.String()
Expand Down