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: add documentation for eglot #40582

Open
ilohmar opened this issue Aug 5, 2020 · 1 comment
Open

x/tools/gopls: add documentation for eglot #40582

ilohmar opened this issue Aug 5, 2020 · 1 comment

Comments

@ilohmar
Copy link

@ilohmar ilohmar commented Aug 5, 2020

What version of Go are you using (go version)?

1.14.2

Does this issue reproduce with the latest release?

yes

What operating system and processor architecture are you using (go env)?

Linux amd64

What did you do?

Look up Emacs integration documentation

What did you expect to see?

At least a mention of the "eglot" package.

What did you see instead?

Only the "lsp-mode" package.

Eglot works nicely with gopls.
To the best of my knowledge, lsp-mode will never be integrated more tightly with Emacs, while eglot is on track for that.
Please consider mentioning eglot in https://github.com/golang/tools/blob/master/gopls/doc/emacs.md.
With go-mode, eglot, and gopls properly installed, all it takes is

(add-hook 'go-mode-hook #'eglot-ensure)

I can supply a config snippet to auto-format code (as in the lsp-mode config example) if it helps.

@gopherbot gopherbot added this to the Unreleased milestone Aug 5, 2020
@muirdm
Copy link

@muirdm muirdm commented Aug 5, 2020

That doc is community maintained, so please open a PR adding an eglot section. Thanks!

@stamblerre stamblerre changed the title x/tools/gopls Documentation suggests lsp-mode for Emacs, should at least mention eglot x/tools/gopls: add documentation for eglot Aug 5, 2020
@stamblerre stamblerre removed this from the Unreleased milestone Aug 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.