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

Add docs about the emacs-client and how to configure it #53

Closed
opti-mix opened this issue Nov 19, 2017 · 2 comments
Closed

Add docs about the emacs-client and how to configure it #53

opti-mix opened this issue Nov 19, 2017 · 2 comments
Assignees
Labels

Comments

@opti-mix
Copy link

Thanks for including the emacs-client!

It would be nice mention the emacs-client in the docs/README.

It would also be helpful to provide an example of what needs to be added to Emacs config to start using this client.

Which key combinations/commands one should use when editing the file to trigger the auto-completion, etc?

If this client is known to have conflicts with some other popular Emacs modes like e.g. ycmd or company-clang, it would be useful to mention what needs to be disabled or configured differently to make sure that cquery emacs client is used.

These emacs-client specific docs could be probably placed in the emacs sub-directory, together with the client's source code.

@topisani You are probably the best candidate for providing this information, or? :-)

@topisani
Copy link
Contributor

yeah definately - the emacs client is still very experimental, and for example it currently breaks most other lsp-mode clients when you have it loaded (not started, just the file loaded). But yep, we definately need docs, though id rather do them in a week or so when its a bit more stable, and less likely to break.

@topisani topisani self-assigned this Nov 19, 2017
@topisani topisani added the emacs label Nov 19, 2017
@MaskRay
Copy link
Contributor

MaskRay commented Dec 27, 2017

There is now a wiki page https://github.com/jacobdufault/cquery/wiki/Emacs
Feel free to contribute to it!

@MaskRay MaskRay closed this as completed Dec 27, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

3 participants