{"action":"opened","number":717,"pull_request":{"url":"https://api.github.com/repos/Microsoft/web-build-tools/pulls/717","id":196794263,"node_id":"MDExOlB1bGxSZXF1ZXN0MTk2Nzk0MjYz","html_url":"https://github.com/Microsoft/web-build-tools/pull/717","diff_url":"https://github.com/Microsoft/web-build-tools/pull/717.diff","patch_url":"https://github.com/Microsoft/web-build-tools/pull/717.patch","issue_url":"https://api.github.com/repos/Microsoft/web-build-tools/issues/717","number":717,"state":"open","locked":false,"title":"[api-extractor] Add support for HTML tags in doc comments","user":{"login":"pgonzal","id":4673363,"node_id":"MDQ6VXNlcjQ2NzMzNjM=","avatar_url":"https://avatars0.githubusercontent.com/u/4673363?v=4","gravatar_id":"","url":"https://api.github.com/users/pgonzal","html_url":"https://github.com/pgonzal","followers_url":"https://api.github.com/users/pgonzal/followers","following_url":"https://api.github.com/users/pgonzal/following{/other_user}","gists_url":"https://api.github.com/users/pgonzal/gists{/gist_id}","starred_url":"https://api.github.com/users/pgonzal/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pgonzal/subscriptions","organizations_url":"https://api.github.com/users/pgonzal/orgs","repos_url":"https://api.github.com/users/pgonzal/repos","events_url":"https://api.github.com/users/pgonzal/events{/privacy}","received_events_url":"https://api.github.com/users/pgonzal/received_events","type":"User","site_admin":false},"body":"Add support for CommonMark-style HTML tags in doc comments.  This can be used to create tables `<tables>` and as a quick hack for other features such as code ranges (`<code>`) or boldface (`<b>`) until the TSDoc parser is integrated.\r\n\r\nTo avoid parsing ambiguities with other AEDoc constructs, API Extractor will ensure that this string is a complete and properly formatted opening or closing HTML tag such as `<td>` or `</td>` or `<img src=\"example.gif\" />`.  Beyond this, API Extractor does NOT attempt to parse the tag attributes, or verify that opening/closing pairs are balanced, or determine whether the nested tree is valid HTML.  That responsibility is left to the consuming documentation engine.\r\n\r\nIf you want a literal HTML tag, it can be escaped using a CommonMark backslash:\r\n\r\n```javascript\r\n/**\r\n * This is shown as a literal \"\\<br />\" tag whereas this \"<br />\" would\r\n * get rendered as an actual paragraph break.\r\n */\r\n```\r\n","created_at":"2018-06-22T17:04:41Z","updated_at":"2018-06-22T17:04:41Z","closed_at":null,"merged_at":null,"merge_commit_sha":null,"assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/Microsoft/web-build-tools/pulls/717/commits","review_comments_url":"https://api.github.com/repos/Microsoft/web-build-tools/pulls/717/comments","review_comment_url":"https://api.github.com/repos/Microsoft/web-build-tools/pulls/comments{/number}","comments_url":"https://api.github.com/repos/Microsoft/web-build-tools/issues/717/comments","statuses_url":"https://api.github.com/repos/Microsoft/web-build-tools/statuses/5e1a24434b38753b208370c3b4342bcdb4a980ec","head":{"label":"Microsoft:pgonzal/ae-html-support","ref":"pgonzal/ae-html-support","sha":"5e1a24434b38753b208370c3b4342bcdb4a980ec","user":{"login":"Microsoft","id":6154722,"node_id":"MDEyOk9yZ2FuaXphdGlvbjYxNTQ3MjI=","avatar_url":"https://avatars2.githubusercontent.com/u/6154722?v=4","gravatar_id":"","url":"https://api.github.com/users/Microsoft","html_url":"https://github.com/Microsoft","followers_url":"https://api.github.com/users/Microsoft/followers","following_url":"https://api.github.com/users/Microsoft/following{/other_user}","gists_url":"https://api.github.com/users/Microsoft/gists{/gist_id}","starred_url":"https://api.github.com/users/Microsoft/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Microsoft/subscriptions","organizations_url":"https://api.github.com/users/Microsoft/orgs","repos_url":"https://api.github.com/users/Microsoft/repos","events_url":"https://api.github.com/users/Microsoft/events{/privacy}","received_events_url":"https://api.github.com/users/Microsoft/received_events","type":"Organization","site_admin":false},"repo":{"id":69618902,"node_id":"MDEwOlJlcG9zaXRvcnk2OTYxODkwMg==","name":"web-build-tools","full_name":"Microsoft/web-build-tools","owner":{"login":"Microsoft","id":6154722,"node_id":"MDEyOk9yZ2FuaXphdGlvbjYxNTQ3MjI=","avatar_url":"https://avatars2.githubusercontent.com/u/6154722?v=4","gravatar_id":"","url":"https://api.github.com/users/Microsoft","html_url":"https://github.com/Microsoft","followers_url":"https://api.github.com/users/Microsoft/followers","following_url":"https://api.github.com/users/Microsoft/following{/other_user}","gists_url":"https://api.github.com/users/Microsoft/gists{/gist_id}","starred_url":"https://api.github.com/users/Microsoft/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Microsoft/subscriptions","organizations_url":"https://api.github.com/users/Microsoft/orgs","repos_url":"https://api.github.com/users/Microsoft/repos","events_url":"https://api.github.com/users/Microsoft/events{/privacy}","received_events_url":"https://api.github.com/users/Microsoft/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Microsoft/web-build-tools","description":"A tool box for large scale web development","fork":false,"url":"https://api.github.com/repos/Microsoft/web-build-tools","forks_url":"https://api.github.com/repos/Microsoft/web-build-tools/forks","keys_url":"https://api.github.com/repos/Microsoft/web-build-tools/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Microsoft/web-build-tools/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Microsoft/web-build-tools/teams","hooks_url":"https://api.github.com/repos/Microsoft/web-build-tools/hooks","issue_events_url":"https://api.github.com/repos/Microsoft/web-build-tools/issues/events{/number}","events_url":"https://api.github.com/repos/Microsoft/web-build-tools/events","assignees_url":"https://api.github.com/repos/Microsoft/web-build-tools/assignees{/user}","branches_url":"https://api.github.com/repos/Microsoft/web-build-tools/branches{/branch}","tags_url":"https://api.github.com/repos/Microsoft/web-build-tools/tags","blobs_url":"https://api.github.com/repos/Microsoft/web-build-tools/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Microsoft/web-build-tools/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Microsoft/web-build-tools/git/refs{/sha}","trees_url":"https://api.github.com/repos/Microsoft/web-build-tools/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Microsoft/web-build-tools/statuses/{sha}","languages_url":"https://api.github.com/repos/Microsoft/web-build-tools/languages","stargazers_url":"https://api.github.com/repos/Microsoft/web-build-tools/stargazers","contributors_url":"https://api.github.com/repos/Microsoft/web-build-tools/contributors","subscribers_url":"https://api.github.com/repos/Microsoft/web-build-tools/subscribers","subscription_url":"https://api.github.com/repos/Microsoft/web-build-tools/subscription","commits_url":"https://api.github.com/repos/Microsoft/web-build-tools/commits{/sha}","git_commits_url":"https://api.github.com/repos/Microsoft/web-build-tools/git/commits{/sha}","comments_url":"https://api.github.com/repos/Microsoft/web-build-tools/comments{/number}","issue_comment_url":"https://api.github.com/repos/Microsoft/web-build-tools/issues/comments{/number}","contents_url":"https://api.github.com/repos/Microsoft/web-build-tools/contents/{+path}","compare_url":"https://api.github.com/repos/Microsoft/web-build-tools/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Microsoft/web-build-tools/merges","archive_url":"https://api.github.com/repos/Microsoft/web-build-tools/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Microsoft/web-build-tools/downloads","issues_url":"https://api.github.com/repos/Microsoft/web-build-tools/issues{/number}","pulls_url":"https://api.github.com/repos/Microsoft/web-build-tools/pulls{/number}","milestones_url":"https://api.github.com/repos/Microsoft/web-build-tools/milestones{/number}","notifications_url":"https://api.github.com/repos/Microsoft/web-build-tools/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Microsoft/web-build-tools/labels{/name}","releases_url":"https://api.github.com/repos/Microsoft/web-build-tools/releases{/id}","deployments_url":"https://api.github.com/repos/Microsoft/web-build-tools/deployments","created_at":"2016-09-30T00:28:20Z","updated_at":"2018-06-22T16:05:38Z","pushed_at":"2018-06-22T16:08:05Z","git_url":"git://github.com/Microsoft/web-build-tools.git","ssh_url":"git@github.com:Microsoft/web-build-tools.git","clone_url":"https://github.com/Microsoft/web-build-tools.git","svn_url":"https://github.com/Microsoft/web-build-tools","homepage":"","size":14446,"stargazers_count":292,"watchers_count":292,"language":"TypeScript","has_issues":true,"has_projects":false,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":75,"mirror_url":null,"archived":false,"open_issues_count":42,"license":null,"forks":75,"open_issues":42,"watchers":292,"default_branch":"master"}},"base":{"label":"Microsoft:master","ref":"master","sha":"3349520de9514d82acc641cc92c618e6d32c042b","user":{"login":"Microsoft","id":6154722,"node_id":"MDEyOk9yZ2FuaXphdGlvbjYxNTQ3MjI=","avatar_url":"https://avatars2.githubusercontent.com/u/6154722?v=4","gravatar_id":"","url":"https://api.github.com/users/Microsoft","html_url":"https://github.com/Microsoft","followers_url":"https://api.github.com/users/Microsoft/followers","following_url":"https://api.github.com/users/Microsoft/following{/other_user}","gists_url":"https://api.github.com/users/Microsoft/gists{/gist_id}","starred_url":"https://api.github.com/users/Microsoft/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Microsoft/subscriptions","organizations_url":"https://api.github.com/users/Microsoft/orgs","repos_url":"https://api.github.com/users/Microsoft/repos","events_url":"https://api.github.com/users/Microsoft/events{/privacy}","received_events_url":"https://api.github.com/users/Microsoft/received_events","type":"Organization","site_admin":false},"repo":{"id":69618902,"node_id":"MDEwOlJlcG9zaXRvcnk2OTYxODkwMg==","name":"web-build-tools","full_name":"Microsoft/web-build-tools","owner":{"login":"Microsoft","id":6154722,"node_id":"MDEyOk9yZ2FuaXphdGlvbjYxNTQ3MjI=","avatar_url":"https://avatars2.githubusercontent.com/u/6154722?v=4","gravatar_id":"","url":"https://api.github.com/users/Microsoft","html_url":"https://github.com/Microsoft","followers_url":"https://api.github.com/users/Microsoft/followers","following_url":"https://api.github.com/users/Microsoft/following{/other_user}","gists_url":"https://api.github.com/users/Microsoft/gists{/gist_id}","starred_url":"https://api.github.com/users/Microsoft/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Microsoft/subscriptions","organizations_url":"https://api.github.com/users/Microsoft/orgs","repos_url":"https://api.github.com/users/Microsoft/repos","events_url":"https://api.github.com/users/Microsoft/events{/privacy}","received_events_url":"https://api.github.com/users/Microsoft/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Microsoft/web-build-tools","description":"A tool box for large scale web development","fork":false,"url":"https://api.github.com/repos/Microsoft/web-build-tools","forks_url":"https://api.github.com/repos/Microsoft/web-build-tools/forks","keys_url":"https://api.github.com/repos/Microsoft/web-build-tools/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Microsoft/web-build-tools/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Microsoft/web-build-tools/teams","hooks_url":"https://api.github.com/repos/Microsoft/web-build-tools/hooks","issue_events_url":"https://api.github.com/repos/Microsoft/web-build-tools/issues/events{/number}","events_url":"https://api.github.com/repos/Microsoft/web-build-tools/events","assignees_url":"https://api.github.com/repos/Microsoft/web-build-tools/assignees{/user}","branches_url":"https://api.github.com/repos/Microsoft/web-build-tools/branches{/branch}","tags_url":"https://api.github.com/repos/Microsoft/web-build-tools/tags","blobs_url":"https://api.github.com/repos/Microsoft/web-build-tools/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Microsoft/web-build-tools/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Microsoft/web-build-tools/git/refs{/sha}","trees_url":"https://api.github.com/repos/Microsoft/web-build-tools/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Microsoft/web-build-tools/statuses/{sha}","languages_url":"https://api.github.com/repos/Microsoft/web-build-tools/languages","stargazers_url":"https://api.github.com/repos/Microsoft/web-build-tools/stargazers","contributors_url":"https://api.github.com/repos/Microsoft/web-build-tools/contributors","subscribers_url":"https://api.github.com/repos/Microsoft/web-build-tools/subscribers","subscription_url":"https://api.github.com/repos/Microsoft/web-build-tools/subscription","commits_url":"https://api.github.com/repos/Microsoft/web-build-tools/commits{/sha}","git_commits_url":"https://api.github.com/repos/Microsoft/web-build-tools/git/commits{/sha}","comments_url":"https://api.github.com/repos/Microsoft/web-build-tools/comments{/number}","issue_comment_url":"https://api.github.com/repos/Microsoft/web-build-tools/issues/comments{/number}","contents_url":"https://api.github.com/repos/Microsoft/web-build-tools/contents/{+path}","compare_url":"https://api.github.com/repos/Microsoft/web-build-tools/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Microsoft/web-build-tools/merges","archive_url":"https://api.github.com/repos/Microsoft/web-build-tools/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Microsoft/web-build-tools/downloads","issues_url":"https://api.github.com/repos/Microsoft/web-build-tools/issues{/number}","pulls_url":"https://api.github.com/repos/Microsoft/web-build-tools/pulls{/number}","milestones_url":"https://api.github.com/repos/Microsoft/web-build-tools/milestones{/number}","notifications_url":"https://api.github.com/repos/Microsoft/web-build-tools/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Microsoft/web-build-tools/labels{/name}","releases_url":"https://api.github.com/repos/Microsoft/web-build-tools/releases{/id}","deployments_url":"https://api.github.com/repos/Microsoft/web-build-tools/deployments","created_at":"2016-09-30T00:28:20Z","updated_at":"2018-06-22T16:05:38Z","pushed_at":"2018-06-22T16:08:05Z","git_url":"git://github.com/Microsoft/web-build-tools.git","ssh_url":"git@github.com:Microsoft/web-build-tools.git","clone_url":"https://github.com/Microsoft/web-build-tools.git","svn_url":"https://github.com/Microsoft/web-build-tools","homepage":"","size":14446,"stargazers_count":292,"watchers_count":292,"language":"TypeScript","has_issues":true,"has_projects":false,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":75,"mirror_url":null,"archived":false,"open_issues_count":42,"license":null,"forks":75,"open_issues":42,"watchers":292,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/Microsoft/web-build-tools/pulls/717"},"html":{"href":"https://github.com/Microsoft/web-build-tools/pull/717"},"issue":{"href":"https://api.github.com/repos/Microsoft/web-build-tools/issues/717"},"comments":{"href":"https://api.github.com/repos/Microsoft/web-build-tools/issues/717/comments"},"review_comments":{"href":"https://api.github.com/repos/Microsoft/web-build-tools/pulls/717/comments"},"review_comment":{"href":"https://api.github.com/repos/Microsoft/web-build-tools/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/Microsoft/web-build-tools/pulls/717/commits"},"statuses":{"href":"https://api.github.com/repos/Microsoft/web-build-tools/statuses/5e1a24434b38753b208370c3b4342bcdb4a980ec"}},"author_association":"CONTRIBUTOR","merged":false,"mergeable":null,"rebaseable":null,"mergeable_state":"unknown","merged_by":null,"comments":0,"review_comments":0,"maintainer_can_modify":false,"commits":3,"additions":302,"deletions":7,"changed_files":13}}
{"actor":{"display_login":"pgonzal"}}