Asterisk seems to be treated specially in documentation preview

[jawnsy]

Description

Documentation 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.

Actual behavior

This comment:

// ValidFileName returns nil if the string is a valid file name, or an
// error otherwise. If pattern is true, file glob patterns are permitted
// ("*" and "?", e.g. "abc*")

is rendered like so:

Notice that the * is missing between "".

Expected behavior

godoc -http renders it like so:

I'd expect this to be correct, though I haven't read godoc spec.

Workaround

You can escape the * in the comment (\*), like so:

// ValidFileName returns nil if the string is a valid file name, or an
// error otherwise. If pattern is true, file glob patterns are permitted
// ("\*" and "?", e.g. "abc*")

Then it appears to be rendered as expected:

Version info

vscode-go 0.6.73

VSCode version info (OS: Windows 10):

Version 1.19.2
Commit 490ef761b76b3f3b3832eff7a588aac891e5fe80
Date 2018-01-10T15:55:03.538Z
Shell 1.7.9
Renderer 58.0.3029.110
Node 7.9.0
Architecture x64

[ramya-rao-a]

Thanks for reporting!
Seems to be an issue with VS Code and not the Go extension.
I get similar issues on hover text when using typescript

[ramya-rao-a]

This issue was moved to microsoft/vscode#42353

[ramya-rao-a]

Reopening as the upstream issue was closed

[ramya-rao-a]

I no longer see this issue with the latest VS Code