Autogenerated documentation doesn't handle special characters properly

[jimen0]

Oto's autogenerated documentation doesn't properly encode special characters such as double quotes. I found this problem while reading pace's docs and reproduced it by myself. You can find an example here:

• Service definition with double quoted text: https://github.com/pacedotdev/pace/blob/d241b53b81fa4d2457bab150a66442263587298b/oto/cards.go#L50-L52 (left browser)
• Generated Go code with encoded double quotes: https://github.com/pacedotdev/pace/blob/d241b53b81fa4d2457bab150a66442263587298b/pace.gen.go#L743-L745 (right browser)

• Docs as displayed on pkg.go.dev: https://pkg.go.dev/github.com/pacedotdev/pace?tab=doc#AddCommentRequest

Please, feel free to close this issue if this is the intended behavior. I was just trying the tool and noticed it.

Best,
Miguel

[matryer]

Infuriating, thanks for reporting @jimen0.

[simonjanss]

This comes from the plush-package, example:

ctx := plush.NewContext()
ctx.Set("search", "tag:'simon'")
text, _ := plush.Render("<%= search %>", ctx)
fmt.Println("output:", text)
// output: tag:&#39;simon&#39

[matryer]

Thanks @simonjanss - Oh so maybe if I change the type to template.HTML it will work. I know Plush respects that.

[matryer]

@jimen0 @simonjanss Thank you - this is much better now that people don't need to learn unicode to read the docs :)

[simonjanss]

@jimen0 @simonjanss Thank you - this is much better now that people don't need to learn unicode to read the docs :)

My pleasure, thank you for a great tool!