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

Escape HTML characters #13744

Merged
merged 1 commit into from
Feb 8, 2019
Merged

Escape HTML characters #13744

merged 1 commit into from
Feb 8, 2019

Conversation

oandregal
Copy link
Member

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.

@oandregal oandregal self-assigned this Feb 7, 2019
@oandregal oandregal added the [Type] Developer Documentation Documentation for developers label Feb 7, 2019
@oandregal oandregal added this to the Documentation & Handbook milestone Feb 7, 2019
@oandregal oandregal added the Good First Review A PR that's suitable for someone looking to contribute for the first time by reviewing code label Feb 7, 2019
Copy link
Member

@aduth aduth left a 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.

@oandregal
Copy link
Member Author

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.

@oandregal oandregal merged commit ed4f8c8 into master Feb 8, 2019
@oandregal oandregal deleted the update/jsdoc-autop branch February 8, 2019 09:21
youknowriad pushed a commit that referenced this pull request Mar 6, 2019
youknowriad pushed a commit that referenced this pull request Mar 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Review A PR that's suitable for someone looking to contribute for the first time by reviewing code [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants