[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/eglot 606e234 48/54: Close #415: mention soft dependenc

From: João Távora
Subject: [elpa] externals/eglot 606e234 48/54: Close #415: mention soft dependencies in README
Date: Thu, 16 Apr 2020 05:31:53 -0400 (EDT)

branch: externals/eglot
commit 606e234ea867d057f201fde9a4de2a896f35782e
Author: João Távora <address@hidden>
Commit: Felicián Németh <address@hidden>

    Close #415: mention soft dependencies in README
    * README.md (How does Eglot work?): Mention soft dependencies.
 README.md | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 7152de6..42e1ffc 100644
--- a/README.md
+++ b/README.md
@@ -304,11 +304,25 @@ If the connection is successful, you see an 
 indicator pop up in your mode-line.  More importantly, this means
 current *and future* file buffers of that major mode *inside your
 current project* automatically become \"managed\" by the LSP server,
-i.e.  information about their contents is exchanged periodically to
-provide enhanced code analysis via `xref-find-definitions`,
-`flymake-mode`, `eldoc-mode`, `completion-at-point`, among others.
+This means that information about these file's contents is exchanged
+periodically to provide enhanced code analysis.  Among other features:
-To "unmanage" these buffers, shutdown the server with `M-x
+* definitions can be found via `xref-find-definitions`;
+* on-the-fly diagnostics are given by `flymake-mode`;
+* function signature hints are given by `eldoc-mode`;
+* completion can be summoned with `completion-at-point`.
+Some extra features are provided if certain libraries are installed
+and enabled, such as:
+* completion dropdowns via [company];
+* snippet completions via [yasnippet];
+* marked-up documentation via [markdown].
+Eglot doesn't _require_ these libraries to work effectively, but will
+use them automatically if they are found to be active.
+To "unmanage" a project's buffers, shutdown the server with `M-x
 # Supported Protocol features
@@ -520,3 +534,4 @@ Under the hood:
 [company]: http://elpa.gnu.org/packages/company.html
 [yasnippet]: http://elpa.gnu.org/packages/yasnippet.html
+[markdown]: https://github.com/defunkt/markdown-mode

reply via email to

[Prev in Thread] Current Thread [Next in Thread]