Skip to content
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.

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

Autogenerated documentation doesn't handle special characters properly #17

Closed
jimen0 opened this issue Aug 23, 2020 · 5 comments
Closed

Comments

@jimen0
Copy link

jimen0 commented Aug 23, 2020

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:

image

image

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
Copy link
Contributor

matryer commented Sep 23, 2020

Infuriating, thanks for reporting @jimen0.

@simonjanss
Copy link

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
Copy link
Contributor

matryer commented Sep 23, 2020

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

matryer added a commit to pacedotdev/pace that referenced this issue Sep 23, 2020
@matryer
Copy link
Contributor

matryer commented Sep 23, 2020

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

@simonjanss
Copy link

@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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants