Conversation
oandregal
added
the
Good First Review
aduth
approved these changes
Feb 7, 2019
Member
aduth
left a comment
aduth
left a comment
There was a problem hiding this comment.
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
force-pushed
the
update/jsdoc-autop
branch
from
2aaa895 to
6ffe31a
Compare
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. |
This was referenced Feb 18, 2019
youknowriad
pushed a commit
that referenced
this pull request
Mar 6, 2019
youknowriad
pushed a commit
that referenced
this pull request
Mar 6, 2019
This was referenced Apr 30, 2020
This was referenced May 1, 2020
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.