docs(md-icon): api missing text

[julianobrasil]

Bug, feature request, or proposal:

Bug

What is the expected behavior?

See the complete explanation of an api item

What is the current behavior?

Some text is missing in specific parts of the md-icon docs (API Tab). Where it should be written something like:

"Returns an Observable that produces the icon (as an <svg> DOM element) from the given URL. The response from the URL may be cached so this will not always cause an HTTP request, but the produced element will always be a new copy of the originally fetched icon. (That is, it will not contain any modifications made to elements previously returned)."

you actually see what is shown in the image bello (that's because of the <svg> tag in the code comment):

[donroyco]

Here's the URL for reference: https://material.angular.io/components/icon/api

[julianobrasil]

@willshowell, what's the right way to fix this error in docs? Does it follow the same Github markdown rules? I mean, is it just a matter of use the backticks (`<sgv>` instead of <sgv>)?

[donroyco]

@julianobrasil *svg ;)

[julianobrasil]

Thanks, @donroyco! Not home right now, but I'll fix it and submit a PR later if no one does it (I was just showing the Material 2 Project to a reluctant developer and this error in the docs didn't help my point of view 😸 ).

[willshowell]

@julianobrasil Yeah it'd almost certainly be fixed by backticks. I'm sure no one would mind either if you added a lint rule to enforce HTML tag escaping too (see the noExposedTodoRule) 😁

[julianobrasil]

@willshowell, of course... just need to make sure that the backticks escapes HTML tags. @donroyco wrote something about asterisks above.

[donroyco]

@julianobrasil It was just a typo reference: sgv » svg

[julianobrasil]

@donroyco, that's why my wife keeps saying I need some rest once in a while 😃. I haven't corrected the docs yet because yesterday I got involved with a mysterious behavior in a project (at the end I found out that if you create an @Output named "change", or named after any html native event, Angular may bubble the native event through it). But I did submit the PR with the tslint rule at least.