Skip to content

docs(icon): fix unescaped open-close (<>) tags in public comments - #7756

Merged
tinayuangao merged 1 commit into
angular:masterfrom
julianobrasil:fix-escape-backtick
Oct 18, 2017
Merged

docs(icon): fix unescaped open-close (<>) tags in public comments#7756
tinayuangao merged 1 commit into
angular:masterfrom
julianobrasil:fix-escape-backtick

Conversation

@julianobrasil

Copy link
Copy Markdown
Contributor

No description provided.

@googlebotgooglebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Oct 13, 2017

@jelbournjelbourn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jelbournjelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker labels Oct 13, 2017
@tinayuangao
tinayuangao merged commit 288c243 into angular:masterOct 18, 2017
@julianobrasil
julianobrasil deleted the fix-escape-backtick branch October 19, 2017 08:11
@julianobrasil

julianobrasil commented Oct 21, 2017

Copy link
Copy Markdown
ContributorAuthor

@jelbourn, backticks doesn't seem to escape html tags at all:

image

The comment in the code is:

/** * Returns an Observable that produces the icon (as an `<svg>` DOM element) with the given name * and namespace. The icon must have been previously registered with addIcon or addIconSet; * if not, the Observable will throw an error. * * @param name Name of the icon to be retrieved. * @param namespace Namespace in which to look for the icon. */

Instead of that blank space in the image above, I expected that the backticks around <svg> would fix the missing parts of the comment and give me this:

 Returns an Observable that produces the icon (as an <svg> DOM element) with the given name
and namespace. The icon must have been previously registered with addIcon or addIconSet;
if not, the Observable will throw an error.

@willshowell

willshowell commented Oct 31, 2017

Copy link
Copy Markdown
Contributor

@julianobrasil this should work via

https://github.com/angular/material2/blob/b39202ff3fb6c509460a42f04aaa291c44490273/tools/dgeni/templates/method.template.html#L14-L16

Did you check that locally? I don't think the docs site has updated with new assets since this was merged.

EDIT: yeah I just checked, it should work fine next release

Returns an Observable that produces the icon (as an <code>&lt;svg&gt;</code> DOM element) with the given name and namespace

@angular-automatic-lock-bot

Copy link
Copy Markdown

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-botangular-automatic-lock-botBot locked and limited conversation to collaborators Sep 7, 2019
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

action: mergeThe PR is ready for merge by the caretakercla: yesPR author has agreed to Google's Contributor License Agreement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@julianobrasil@willshowell@jelbourn@googlebot@tinayuangao