Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

x/tools/gopls: format godoc comments as markdown correctly #34161

Open
stamblerre opened this issue Sep 7, 2019 · 1 comment

Comments

@stamblerre
Copy link
Contributor

commented Sep 7, 2019

Forked from #29151:

As I'm sure you are aware, note that Go doc strings are not Markdown but rather have their own minimalistic formatting. For them to display with formatting correctly they will need to be converted to Markdown before returning them if we want them to show up formatted in the editor correctly. See microsoft/vscode-go#2245 where I implemented this transformation albeit in JS and here it is needed in Go.

@gopherbot gopherbot added this to the Unreleased milestone Sep 7, 2019

@gopherbot gopherbot added the gopls label Sep 7, 2019

@gopherbot

This comment has been minimized.

Copy link

commented Sep 7, 2019

Thank you for filing a gopls issue! Please take a look at the Troubleshooting section of the gopls Wiki page, and make sure that you have provided all of the relevant information here.

@stamblerre stamblerre added the NeedsFix label Sep 7, 2019

@stamblerre stamblerre changed the title x/tools/gopls: format go doc comments as markdown correctly x/tools/gopls: format godoc comments as markdown correctly Sep 7, 2019

@stamblerre stamblerre added the Tools label Sep 9, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.