[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
feature/eglot2emacs 7c712abf8f 009/120: Minor checkdoc fixes
From: |
João Távora |
Subject: |
feature/eglot2emacs 7c712abf8f 009/120: Minor checkdoc fixes |
Date: |
Thu, 20 Oct 2022 07:16:45 -0400 (EDT) |
branch: feature/eglot2emacs
commit 7c712abf8f8e6f9a85b80339c00316c35b4beb14
Author: Stefan Kangas <stefankangas@gmail.com>
Commit: Stefan Kangas <stefankangas@gmail.com>
Minor checkdoc fixes
* eglot.el (eglot, eglot--when-buffer-window, eglot--widening)
(eglot-initialization-options, eglot--current-flymake-report-fn)
(eglot-handle-notification, eglot-handle-request)
(eglot--highlight-piggyback, eglot-register-capability)
(eglot-unregister-capability):
* eglot-tests.el (auto-detect-running-server, auto-shutdown)
(auto-reconnect, eglot--tests-force-full-eldoc, rename-a-symbol)
(basic-completions, non-unique-completions, basic-xref)
(snippet-completions, snippet-completions-with-company)
(eglot-eldoc-after-completions, python-yapf-formatting)
(javascript-basic, json-basic, eglot-ensure)
(eglot--guessing-contact): Doc fixes; formatting.
* eglot.el (xref-backend-identifier-completion-table): Fix error
format.
---
lisp/progmodes/eglot.el | 42 +++++++++++++++++++++---------------------
1 file changed, 21 insertions(+), 21 deletions(-)
diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el
index e9f48bb3c3..234e4f14e7 100644
--- a/lisp/progmodes/eglot.el
+++ b/lisp/progmodes/eglot.el
@@ -91,7 +91,7 @@
;;; User tweakable stuff
(defgroup eglot nil
- "Interaction with Language Server Protocol servers"
+ "Interaction with Language Server Protocol servers."
:prefix "eglot-"
:group 'applications)
@@ -577,7 +577,7 @@ treated as in `eglot-dbind'."
`(let ((,b ,buf)) (if (buffer-live-p ,b) (with-current-buffer ,b
,@body)))))
(cl-defmacro eglot--when-buffer-window (buf &body body)
- "Check BUF showing somewhere, then do BODY in it" (declare (indent 1) (debug
t))
+ "Check BUF showing somewhere, then do BODY in it." (declare (indent 1)
(debug t))
(let ((b (cl-gensym)))
`(let ((,b ,buf))
;;notice the exception when testing with `ert'
@@ -585,7 +585,7 @@ treated as in `eglot-dbind'."
(with-current-buffer ,b ,@body)))))
(cl-defmacro eglot--widening (&rest body)
- "Save excursion and restriction. Widen. Then run BODY." (declare (debug t))
+ "Save excursion and restriction. Widen. Then run BODY." (declare (debug t))
`(save-excursion (save-restriction (widen) ,@body)))
(cl-defgeneric eglot-handle-request (server method &rest params)
@@ -598,7 +598,7 @@ treated as in `eglot-dbind'."
"Ask SERVER to execute COMMAND with ARGUMENTS.")
(cl-defgeneric eglot-initialization-options (server)
- "JSON object to send under `initializationOptions'"
+ "JSON object to send under `initializationOptions'."
(:method (_s) eglot--{})) ; blank default
(cl-defgeneric eglot-register-capability (server method id &rest params)
@@ -1481,7 +1481,7 @@ and just return it. PROMPT shouldn't end with a question
mark."
map))
(defvar-local eglot--current-flymake-report-fn nil
- "Current flymake report function for this buffer")
+ "Current flymake report function for this buffer.")
(defvar-local eglot--saved-bindings nil
"Bindings saved by `eglot--setq-saving'.")
@@ -1734,14 +1734,14 @@ Uses THING, FACE, DEFS and PREPEND."
;;;
(cl-defmethod eglot-handle-notification
(_server method &key &allow-other-keys)
- "Handle unknown notification"
+ "Handle unknown notification."
(unless (or (string-prefix-p "$" (format "%s" method))
(not (memq 'disallow-unknown-methods eglot-strict-mode)))
(eglot--warn "Server sent unknown notification method `%s'" method)))
(cl-defmethod eglot-handle-request
(_server method &key &allow-other-keys)
- "Handle unknown request"
+ "Handle unknown request."
(when (memq 'disallow-unknown-methods eglot-strict-mode)
(jsonrpc-error "Unknown request method `%s'" method)))
@@ -1754,14 +1754,14 @@ COMMAND is a symbol naming the command."
(cl-defmethod eglot-handle-notification
(_server (_method (eql window/showMessage)) &key type message)
- "Handle notification window/showMessage"
+ "Handle notification window/showMessage."
(eglot--message (propertize "Server reports (type=%s): %s"
'face (if (<= type 1) 'error))
type message))
(cl-defmethod eglot-handle-request
(_server (_method (eql window/showMessageRequest)) &key type message actions)
- "Handle server request window/showMessageRequest"
+ "Handle server request window/showMessageRequest."
(let* ((actions (append actions nil)) ;; gh#627
(label (completing-read
(concat
@@ -1776,16 +1776,16 @@ COMMAND is a symbol naming the command."
(cl-defmethod eglot-handle-notification
(_server (_method (eql window/logMessage)) &key _type _message)
- "Handle notification window/logMessage") ;; noop, use events buffer
+ "Handle notification window/logMessage.") ;; noop, use events buffer
(cl-defmethod eglot-handle-notification
(_server (_method (eql telemetry/event)) &rest _any)
- "Handle notification telemetry/event") ;; noop, use events buffer
+ "Handle notification telemetry/event.") ;; noop, use events buffer
(cl-defmethod eglot-handle-notification
(server (_method (eql textDocument/publishDiagnostics)) &key uri diagnostics
&allow-other-keys) ; FIXME: doesn't respect `eglot-strict-mode'
- "Handle notification publishDiagnostics"
+ "Handle notification publishDiagnostics."
(if-let ((buffer (find-buffer-visiting (eglot--uri-to-path uri))))
(with-current-buffer buffer
(cl-loop
@@ -1839,18 +1839,18 @@ THINGS are either registrations or unregisterations
(sic)."
(cl-defmethod eglot-handle-request
(server (_method (eql client/registerCapability)) &key registrations)
- "Handle server request client/registerCapability"
+ "Handle server request client/registerCapability."
(eglot--register-unregister server registrations 'register))
(cl-defmethod eglot-handle-request
(server (_method (eql client/unregisterCapability))
&key unregisterations) ;; XXX: "unregisterations" (sic)
- "Handle server request client/unregisterCapability"
+ "Handle server request client/unregisterCapability."
(eglot--register-unregister server unregisterations 'unregister))
(cl-defmethod eglot-handle-request
(_server (_method (eql workspace/applyEdit)) &key _label edit)
- "Handle server request workspace/applyEdit"
+ "Handle server request workspace/applyEdit."
(eglot--apply-workspace-edit edit eglot-confirm-server-initiated-edits))
(defun eglot--TextDocumentIdentifier ()
@@ -2180,7 +2180,7 @@ Try to visit the target file for a richer summary line."
(xref-make-match summary (xref-make-file-location file line column)
length)))
(cl-defmethod xref-backend-identifier-completion-table ((_backend (eql eglot)))
- (eglot--error "cannot (yet) provide reliable completion table for LSP
symbols"))
+ (eglot--error "Cannot (yet) provide reliable completion table for LSP
symbols"))
(cl-defmethod xref-backend-identifier-at-point ((_backend (eql eglot)))
;; JT@19/10/09: This is a totally dummy identifier that isn't even
@@ -2578,7 +2578,7 @@ is not active."
(defvar eglot--highlights nil "Overlays for textDocument/documentHighlight.")
(defun eglot--highlight-piggyback (_cb)
- "Request and handle `:textDocument/documentHighlight'"
+ "Request and handle `:textDocument/documentHighlight'."
;; FIXME: Obviously, this is just piggy backing on eldoc's calls for
;; convenience, as shown by the fact that we just ignore cb.
(let ((buf (current-buffer)))
@@ -2821,7 +2821,7 @@ at point. With prefix argument, prompt for ACTION-KIND."
;;;
(cl-defmethod eglot-register-capability
(server (method (eql workspace/didChangeWatchedFiles)) id &key watchers)
- "Handle dynamic registration of workspace/didChangeWatchedFiles"
+ "Handle dynamic registration of workspace/didChangeWatchedFiles."
(eglot-unregister-capability server method id)
(let* (success
(globs (mapcar
@@ -2863,7 +2863,7 @@ at point. With prefix argument, prompt for ACTION-KIND."
(cl-defmethod eglot-unregister-capability
(server (_method (eql workspace/didChangeWatchedFiles)) id)
- "Handle dynamic unregistration of workspace/didChangeWatchedFiles"
+ "Handle dynamic unregistration of workspace/didChangeWatchedFiles."
(mapc #'file-notify-rm-watch (gethash id (eglot--file-watches server)))
(remhash id (eglot--file-watches server))
(list t "OK"))
@@ -2948,7 +2948,7 @@ If NOERROR, return predicate, else erroring function."
(cl-defmethod eglot-handle-notification
((server eglot-rls) (_method (eql window/progress))
&key id done title message &allow-other-keys)
- "Handle notification window/progress"
+ "Handle notification window/progress."
(setf (eglot--spinner server) (list id title done message)))
@@ -2958,7 +2958,7 @@ If NOERROR, return predicate, else erroring function."
:documentation "Eclipse's Java Development Tools Language Server.")
(cl-defmethod eglot-initialization-options ((server eglot-eclipse-jdt))
- "Passes through required jdt initialization options"
+ "Passes through required jdt initialization options."
`(:workspaceFolders
[,@(cl-delete-duplicates
(mapcar #'eglot--path-to-uri
- feature/eglot2emacs 3967d22b9c 005/120: ; fix typos, (continued)
- feature/eglot2emacs 3967d22b9c 005/120: ; fix typos, João Távora, 2022/10/20
- feature/eglot2emacs 5c6eb3caa9 074/120: Don't ignore flymake-no-changes-timeout, João Távora, 2022/10/20
- feature/eglot2emacs 6ee995fe6b 094/120: Add marksman server for markdown, João Távora, 2022/10/20
- feature/eglot2emacs 0e8a8697ba 092/120: Merge commit '7738854e09' to fix fallout of force-push in gnu elpa, João Távora, 2022/10/20
- feature/eglot2emacs 51ae66b50c 099/120: Add eglot-show-configuration to debug workspace configurations, João Távora, 2022/10/20
- feature/eglot2emacs 14586fedcf 103/120: Don't exceed max-specdl-size in big go projects, João Távora, 2022/10/20
- feature/eglot2emacs a8b3b6a526 014/120: Add vim-language-server for vimrc-mode, João Távora, 2022/10/20
- feature/eglot2emacs b1c7aa1d17 003/120: Add yaml-language-server for yaml-mode, João Távora, 2022/10/20
- feature/eglot2emacs 51fc8fc3d2 002/120: Use `locate-user-emacs-file` instead of `concat`, João Távora, 2022/10/20
- feature/eglot2emacs 06f1cd6365 008/120: Add lua-lsp support for lua-mode, João Távora, 2022/10/20
- feature/eglot2emacs 7c712abf8f 009/120: Minor checkdoc fixes,
João Távora <=
- 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