Skip to content
This repository has been archived by the owner on Jul 15, 2023. It is now read-only.

full package docs in a separate view #1237

Closed
apiarian opened this issue Sep 21, 2017 · 3 comments
Closed

full package docs in a separate view #1237

apiarian opened this issue Sep 21, 2017 · 3 comments

Comments

@apiarian
Copy link

It would be great to have access to the output of godoc for a package (and possibly a specific identifier) within the editor without having to open up a browser to godoc.org or similar.

Should be possible using https://code.visualstudio.com/docs/extensionAPI/vscode-api#TextDocumentContentProvider . Some care will need to be taken to handle vendored code correctly. godoc seems to default to looking in the $GOPATH or $GOROOT so we'll probably have to explicitly check $PROJECTROOT/vendor first.

I'd like to take this issue on myself, but it'll be my first foray into vscode extensions out of my backend-development cave, so if somebody is keen to see this quicker, please let me know. I'd certainly be willing to hand the branch over or collaborate on the work.

@apiarian
Copy link
Author

Looks like this is probably related to #789

@apiarian
Copy link
Author

created https://github.com/apiarian/vscode-go-test-docs-main to help with documentation experiments.

@ramya-rao-a
Copy link
Contributor

@apiarian Let's use #789 to track this.

@vscodebot vscodebot bot locked and limited conversation to collaborators Jan 24, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants