{"action":"created","issue":{"url":"https://api.github.com/repos/Microsoft/vscode/issues/42353","repository_url":"https://api.github.com/repos/Microsoft/vscode","labels_url":"https://api.github.com/repos/Microsoft/vscode/issues/42353/labels{/name}","comments_url":"https://api.github.com/repos/Microsoft/vscode/issues/42353/comments","events_url":"https://api.github.com/repos/Microsoft/vscode/issues/42353/events","html_url":"https://github.com/Microsoft/vscode/issues/42353","id":292516561,"number":42353,"title":"Asterisk seems to be treated specially in documentation preview","user":{"login":"ramya-rao-a","id":16890566,"avatar_url":"https://avatars1.githubusercontent.com/u/16890566?v=4","gravatar_id":"","url":"https://api.github.com/users/ramya-rao-a","html_url":"https://github.com/ramya-rao-a","followers_url":"https://api.github.com/users/ramya-rao-a/followers","following_url":"https://api.github.com/users/ramya-rao-a/following{/other_user}","gists_url":"https://api.github.com/users/ramya-rao-a/gists{/gist_id}","starred_url":"https://api.github.com/users/ramya-rao-a/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ramya-rao-a/subscriptions","organizations_url":"https://api.github.com/users/ramya-rao-a/orgs","repos_url":"https://api.github.com/users/ramya-rao-a/repos","events_url":"https://api.github.com/users/ramya-rao-a/events{/privacy}","received_events_url":"https://api.github.com/users/ramya-rao-a/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":{"login":"mjbvz","id":12821956,"avatar_url":"https://avatars2.githubusercontent.com/u/12821956?v=4","gravatar_id":"","url":"https://api.github.com/users/mjbvz","html_url":"https://github.com/mjbvz","followers_url":"https://api.github.com/users/mjbvz/followers","following_url":"https://api.github.com/users/mjbvz/following{/other_user}","gists_url":"https://api.github.com/users/mjbvz/gists{/gist_id}","starred_url":"https://api.github.com/users/mjbvz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mjbvz/subscriptions","organizations_url":"https://api.github.com/users/mjbvz/orgs","repos_url":"https://api.github.com/users/mjbvz/repos","events_url":"https://api.github.com/users/mjbvz/events{/privacy}","received_events_url":"https://api.github.com/users/mjbvz/received_events","type":"User","site_admin":false},"assignees":[{"login":"mjbvz","id":12821956,"avatar_url":"https://avatars2.githubusercontent.com/u/12821956?v=4","gravatar_id":"","url":"https://api.github.com/users/mjbvz","html_url":"https://github.com/mjbvz","followers_url":"https://api.github.com/users/mjbvz/followers","following_url":"https://api.github.com/users/mjbvz/following{/other_user}","gists_url":"https://api.github.com/users/mjbvz/gists{/gist_id}","starred_url":"https://api.github.com/users/mjbvz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mjbvz/subscriptions","organizations_url":"https://api.github.com/users/mjbvz/orgs","repos_url":"https://api.github.com/users/mjbvz/repos","events_url":"https://api.github.com/users/mjbvz/events{/privacy}","received_events_url":"https://api.github.com/users/mjbvz/received_events","type":"User","site_admin":false},{"login":"ramya-rao-a","id":16890566,"avatar_url":"https://avatars1.githubusercontent.com/u/16890566?v=4","gravatar_id":"","url":"https://api.github.com/users/ramya-rao-a","html_url":"https://github.com/ramya-rao-a","followers_url":"https://api.github.com/users/ramya-rao-a/followers","following_url":"https://api.github.com/users/ramya-rao-a/following{/other_user}","gists_url":"https://api.github.com/users/ramya-rao-a/gists{/gist_id}","starred_url":"https://api.github.com/users/ramya-rao-a/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ramya-rao-a/subscriptions","organizations_url":"https://api.github.com/users/ramya-rao-a/orgs","repos_url":"https://api.github.com/users/ramya-rao-a/repos","events_url":"https://api.github.com/users/ramya-rao-a/events{/privacy}","received_events_url":"https://api.github.com/users/ramya-rao-a/received_events","type":"User","site_admin":false}],"milestone":null,"comments":9,"created_at":"2018-01-29T18:43:10Z","updated_at":"2018-02-02T20:36:35Z","closed_at":null,"author_association":"MEMBER","body":"_From @jawnsy on January 29, 2018 17:43_\n\n**Description**\r\n\r\nDocumentation preview requires an asterisk to be escaped, while `godoc` does not require the escaping. This is a pretty minor issue but I'd expect vscode-go to behave as close to `godoc` as possible.\r\n\r\n**Actual behavior**\r\n\r\nThis comment:\r\n\r\n```go\r\n// ValidFileName returns nil if the string is a valid file name, or an\r\n// error otherwise. If pattern is true, file glob patterns are permitted\r\n// (\"*\" and \"?\", e.g. \"abc*\")\r\n```\r\n\r\nis rendered like so:\r\n\r\n![actual](https://user-images.githubusercontent.com/52710/35525071-4f20a43e-04d8-11e8-9619-a8f2d8e060da.png)\r\n\r\nNotice that the * is missing between \"\".\r\n\r\n**Expected behavior**\r\n\r\n`godoc -http` renders it like so:\r\n\r\n![godoc](https://user-images.githubusercontent.com/52710/35525064-4aa133a6-04d8-11e8-9a5b-51b306bb1611.PNG)\r\n\r\nI'd expect this to be correct, though I haven't read godoc spec.\r\n\r\n**Workaround**\r\n\r\nYou can escape the * in the comment (`\\*`), like so:\r\n\r\n```go\r\n// ValidFileName returns nil if the string is a valid file name, or an\r\n// error otherwise. If pattern is true, file glob patterns are permitted\r\n// (\"\\*\" and \"?\", e.g. \"abc*\")\r\n```\r\n\r\nThen it appears to be rendered as expected:\r\n\r\n![workaround](https://user-images.githubusercontent.com/52710/35525157-8de95508-04d8-11e8-88f4-4e74d273875d.png)\r\n\r\n**Version info**\r\n\r\nvscode-go 0.6.73\r\n\r\nVSCode version info (OS: Windows 10):\r\n\r\n```\r\nVersion 1.19.2\r\nCommit 490ef761b76b3f3b3832eff7a588aac891e5fe80\r\nDate 2018-01-10T15:55:03.538Z\r\nShell 1.7.9\r\nRenderer 58.0.3029.110\r\nNode 7.9.0\r\nArchitecture x64\r\n```\n\n_Copied from original issue: Microsoft/vscode-go#1486_"},"comment":{"url":"https://api.github.com/repos/Microsoft/vscode/issues/comments/362699811","html_url":"https://github.com/Microsoft/vscode/issues/42353#issuecomment-362699811","issue_url":"https://api.github.com/repos/Microsoft/vscode/issues/42353","id":362699811,"user":{"login":"mjbvz","id":12821956,"avatar_url":"https://avatars2.githubusercontent.com/u/12821956?v=4","gravatar_id":"","url":"https://api.github.com/users/mjbvz","html_url":"https://github.com/mjbvz","followers_url":"https://api.github.com/users/mjbvz/followers","following_url":"https://api.github.com/users/mjbvz/following{/other_user}","gists_url":"https://api.github.com/users/mjbvz/gists{/gist_id}","starred_url":"https://api.github.com/users/mjbvz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mjbvz/subscriptions","organizations_url":"https://api.github.com/users/mjbvz/orgs","repos_url":"https://api.github.com/users/mjbvz/repos","events_url":"https://api.github.com/users/mjbvz/events{/privacy}","received_events_url":"https://api.github.com/users/mjbvz/received_events","type":"User","site_admin":false},"created_at":"2018-02-02T20:36:35Z","updated_at":"2018-02-02T20:36:35Z","author_association":"CONTRIBUTOR","body":"@ramya-rao-a In general, or for a given jsdoc?"}}
{"actor":{"display_login":"mjbvz"}}