[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
feature/eglot2emacs a905bad633 024/120: * eglot.el: improve commentary s
From: |
João Távora |
Subject: |
feature/eglot2emacs a905bad633 024/120: * eglot.el: improve commentary section. |
Date: |
Thu, 20 Oct 2022 07:16:46 -0400 (EDT) |
branch: feature/eglot2emacs
commit a905bad63305b456eeaaa5d716b9f7fcb60ec5ab
Author: Stefan Kangas <stefankangas@gmail.com>
Commit: Stefan Kangas <stefankangas@gmail.com>
* eglot.el: improve commentary section.
---
lisp/progmodes/eglot.el | 37 +++++++++++++++++++------------------
1 file changed, 19 insertions(+), 18 deletions(-)
diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el
index 4fa2b073b1..813b29775e 100644
--- a/lisp/progmodes/eglot.el
+++ b/lisp/progmodes/eglot.el
@@ -26,35 +26,36 @@
;;; Commentary:
-;; Simply M-x eglot should be enough to get you started, but here's a
+;; Eglot ("Emacs Polyglot") is an Emacs LSP client that stays out of
+;; your way.
+;;
+;; Typing M-x eglot should be enough to get you started, but here's a
;; little info (see the accompanying README.md or the URL for more).
;;
-;; M-x eglot starts a server via a shell-command guessed from
-;; `eglot-server-programs', using the current major-mode (for whatever
+;; M-x eglot starts a server via a shell command guessed from
+;; `eglot-server-programs', using the current major mode (for whatever
;; language you're programming in) as a hint. If it can't guess, it
-;; prompts you in the mini-buffer for these things. Actually, the
-;; server needen't be locally started: you can connect to a running
-;; server via TCP by entering a <host:port> syntax.
+;; prompts you in the minibuffer for these things. Actually, the
+;; server does not need to be running locally: you can connect to a
+;; running server via TCP by entering a <host:port> syntax.
;;
-;; Anyway, if the connection is successful, you should see an `eglot'
+;; If the connection is successful, you should see an `eglot'
;; 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
+;; that current *and future* file buffers of that major mode *inside
+;; your current project* automatically become \"managed\" by the LSP
+;; server. In other words, information about their content is
+;; exchanged periodically to provide enhanced code analysis using
;; `xref-find-definitions', `flymake-mode', `eldoc-mode',
;; `completion-at-point', among others.
;;
-;; To "unmanage" these buffers, shutdown the server with M-x
-;; eglot-shutdown.
+;; To "unmanage" these buffers, shutdown the server with
+;; M-x eglot-shutdown.
;;
-;; You can also do:
+;; To start an eglot session automatically when a foo-mode buffer is
+;; visited, you can put this in your init file:
;;
;; (add-hook 'foo-mode-hook 'eglot-ensure)
-;;
-;; To attempt to start an eglot session automatically every time a
-;; foo-mode buffer is visited.
-;;
+
;;; Code:
(require 'json)
- feature/eglot2emacs 8a9959e054 039/120: Add clojure-lsp support for clojure, (continued)
- feature/eglot2emacs 8a9959e054 039/120: Add clojure-lsp support for clojure, João Távora, 2022/10/20
- feature/eglot2emacs bc05805887 036/120: ; unbreak tests on emacs 26, João Távora, 2022/10/20
- feature/eglot2emacs 8b31247f1c 044/120: Properly check the completionitem.deprecated property, João Távora, 2022/10/20
- feature/eglot2emacs 5b88ec259c 026/120: Change from symbol-at-point to thing-at-point, João Távora, 2022/10/20
- feature/eglot2emacs 3aeebe8186 037/120: Change rust language server to rust-analyzer, João Távora, 2022/10/20
- feature/eglot2emacs ed4fd33223 043/120: * eglot.el (eglot-handle-notification): silence byte-compiler., João Távora, 2022/10/20
- feature/eglot2emacs 5b62d0071e 040/120: Enable lsp project-wide diagnostics via flymake, João Távora, 2022/10/20
- feature/eglot2emacs 5d2f6bc667 055/120: Map more emacs variables to lsp formattingoptions fields, João Távora, 2022/10/20
- feature/eglot2emacs c06860b0f4 022/120: Bump eglot version to 1.8, João Távora, 2022/10/20
- feature/eglot2emacs 97ded82277 033/120: ; * eglot.el: move obsolete definition to new section., João Távora, 2022/10/20
- feature/eglot2emacs a905bad633 024/120: * eglot.el: improve commentary section.,
João Távora <=
- feature/eglot2emacs f550342059 069/120: Add out-of-box support for purescript lsp server, João Távora, 2022/10/20
- feature/eglot2emacs f8344871a0 075/120: Update docstring of eglot-events-buffer-size, João Távora, 2022/10/20
- feature/eglot2emacs e72fa6d867 082/120: Experiment with grouping in xref-backend-identifier-completion-table, João Távora, 2022/10/20
- feature/eglot2emacs fd5a5f16d7 081/120: Make c-u m-. work half decently, João Távora, 2022/10/20
- feature/eglot2emacs 6c8aee268d 079/120: Prevent desktop.el from saving/restoring eglot--managed-mode, João Távora, 2022/10/20
- feature/eglot2emacs 41a42e631b 096/120: Don't return poorly supported "special elements" in eglot-imenu, João Távora, 2022/10/20
- feature/eglot2emacs f06a837f29 109/120: Shoosh byte-compilation warnings about line numbering functions, João Távora, 2022/10/20
- feature/eglot2emacs 806734c1b1 119/120: Expose eglot-{} to be used in eglot-workspace-configuration, João Távora, 2022/10/20
- feature/eglot2emacs 426d97f172 001/120: ; prefer https to http addresses, João Távora, 2022/10/20
- feature/eglot2emacs fb8706165c 004/120: Use fortls also for fortran-mode, João Távora, 2022/10/20