[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/eglot a8d01327ef: * eglot.el: Improve Commentary sectio
From: |
ELPA Syncer |
Subject: |
[elpa] externals/eglot a8d01327ef: * eglot.el: Improve Commentary section. |
Date: |
Thu, 13 Jan 2022 07:01:48 -0500 (EST) |
branch: externals/eglot
commit a8d01327ef2b70b1f41178f34c30028050ab83e5
Author: Stefan Kangas <stefan@marxist.se>
Commit: Stefan Kangas <stefan@marxist.se>
* eglot.el: Improve Commentary section.
---
eglot.el | 37 +++++++++++++++++++------------------
1 file changed, 19 insertions(+), 18 deletions(-)
diff --git a/eglot.el b/eglot.el
index 4fa2b073b1..813b29775e 100644
--- a/eglot.el
+++ b/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)
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [elpa] externals/eglot a8d01327ef: * eglot.el: Improve Commentary section.,
ELPA Syncer <=