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

Special characters not escaped correctly #291

Open
tong opened this issue Oct 14, 2021 · 1 comment
Open

Special characters not escaped correctly #291

tong opened this issue Oct 14, 2021 · 1 comment

Comments

@tong
Copy link
Contributor

tong commented Oct 14, 2021

Using special characters in non-code md breaks html rendering.

Example: https://api.armory3d.org/iron/Scene.html#getChildren
… html after @return is cluttered as it's defined as:

@return Array<Object>

This works:

@return `Array<Object>`

If this is intentional and not gonna get fixed it should be noted in the documentation.

@Gama11
Copy link
Member

Gama11 commented Oct 14, 2021

That's not intentional, although I would also argue @return hints like that are completely useless in a statically typed language.

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

2 participants