-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
Escape HTML characters #13744
Escape HTML characters #13744
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally fine with this, but it seems like the sort of thing which ought to be (a) automated by the documentation generator and/or (b) enforced via linting rules.
2aaa895
to
6ffe31a
Compare
My concern with those is that you could write HTML as markup (not as part of the contents) intentionally (see first example). Because this is the only occurrence I've found I thought about deferring the decision until it becomes an issue and fix this manually. |
We are about to use JSDoc comment description to generate some documentation in Markdown format (and potentially others).
HTML tags need to be escaped for Markdown not to consider them HTML.