[Top][All Lists]

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

[elpa] externals/eglot 9f10a27 42/54: Explain the animations in the READ

From: João Távora
Subject: [elpa] externals/eglot 9f10a27 42/54: Explain the animations in the README
Date: Thu, 16 Apr 2020 05:31:52 -0400 (EDT)

branch: externals/eglot
commit 9f10a279a52002ff55e929917a6710f918834ad9
Author: Felicián Németh <address@hidden>
Commit: Felicián Németh <address@hidden>

    Explain the animations in the README
    * README.md (animated_gifs): Rearrange and explain the animations.
 README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 52 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5a93465..fc20623 100644
--- a/README.md
+++ b/README.md
@@ -375,14 +375,61 @@ eglot-shutdown`.
 <a name="animated_gifs"></a>
 # _Obligatory animated gif section_
+## Completion
+The animation shows [company-mode][company] presenting the completion
+candidates to the user, but Eglot works with the built-in
+`completion-at-point` function as well, which is usually bound to
+## Snippet completion
+Eglot provides template based completion if the server supports
+snippet completion and [yasnippet][yasnippet] is enabled _before_
+Eglot connects to the server.  The animation shows
+[company-mode][company], but `completion-at-point` also works with
+## Diagnostics
+Eglot relays the diagnostics information received from the server to
+[flymake][flymake].  Command `display-local-help` (bound to `C-h .`)
+shows the diagnostic message under point, but flymake provides other
+convenient ways to handle diagnostic errors.
+When Eglot manages a buffer, it disables other flymake backends.  See
+variable `eglot-stay-out-of` to change that.
+## Code Actions
+The server may provide code actions, for example, to fix a diagnostic
+error or to suggest refactoring edits.  Command `eglot-code-actions`
+queries the server for possible code actions at point.  See variable
+`eglot-confirm-server-initiated-edits` to customize its behavior.
+## Hover on symbol
+## Rename
+Type `M-x eglot-rename RET` to rename the symbol at point.
+## Find definition
+To jump to the definition of a symbol, use the built-in
+`xref-find-definitions` command, which is bound to `M-.`.
+## Find references
+Eglot here relies on emacs' built-in functionality as well.
+`xref-find-references` is bound to `M-?`.
 # Historical differences to lsp-mode.el
@@ -464,3 +511,6 @@ Under the hood:
 [ada_language_server]: https://github.com/AdaCore/ada_language_server
 [metals]: http://scalameta.org/metals/
 [digestif]: https://github.com/astoff/digestif
+[company]: http://elpa.gnu.org/packages/company.html
+[yasnippet]: http://elpa.gnu.org/packages/yasnippet.html

reply via email to

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