emacs-elpa-diffs
[Top][All Lists]
Advanced

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

[elpa] externals/elpa 88e3655 040/139: Appease checkdoc.el


From: João Távora
Subject: [elpa] externals/elpa 88e3655 040/139: Appease checkdoc.el
Date: Mon, 14 May 2018 09:53:31 -0400 (EDT)

branch: externals/elpa
commit 88e36555fab9375000aca7dccf37d7e0d3a8861a
Author: João Távora <address@hidden>
Commit: João Távora <address@hidden>

    Appease checkdoc.el
    
    * eglot.el (eglot--process-send, eglot--next-request-id)
    (eglot--current-buffer-VersionedTextDocumentIdentifier)
    (eglot--current-buffer-TextDocumentItem)
    (eglot--after-change, eglot--signalDidOpen)
    (eglot--signalDidClose, eglot--maybe-signal-didChange):
    Add docstring.
---
 eglot.el | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/eglot.el b/eglot.el
index 8bb0729..cd546a3 100644
--- a/eglot.el
+++ b/eglot.el
@@ -390,6 +390,7 @@ identifier.  ERROR is non-nil if this is an error."
 (defvar eglot--expect-carriage-return nil)
 
 (defun eglot--process-send (id proc message)
+  "Send MESSAGE to PROC (ID is optional)."
   (let* ((json (json-encode message))
          (to-send (format "Content-Length: %d\r\n\r\n%s"
                           (string-bytes json)
@@ -403,6 +404,7 @@ identifier.  ERROR is non-nil if this is an error."
 (defvar eglot--next-request-id 0)
 
 (defun eglot--next-request-id ()
+  "Compute the next id for a client request."
   (setq eglot--next-request-id (1+ eglot--next-request-id)))
 
 (defun eglot-forget-pending-continuations (process)
@@ -789,6 +791,7 @@ running.  INTERACTIVE is t if called interactively."
   eglot--versioned-identifier)
 
 (defun eglot--current-buffer-VersionedTextDocumentIdentifier ()
+  "Compute VersionedTextDocumentIdentifier object for current buffer."
   (eglot--obj :uri
               (concat "file://"
                       (url-hexify-string
@@ -797,6 +800,7 @@ running.  INTERACTIVE is t if called interactively."
               :version (eglot--current-buffer-versioned-identifier)))
 
 (defun eglot--current-buffer-TextDocumentItem ()
+  "Compute TextDocumentItem object for current buffer."
   (append
    (eglot--current-buffer-VersionedTextDocumentIdentifier)
    (eglot--obj :languageId (cdr (assoc major-mode
@@ -808,24 +812,29 @@ running.  INTERACTIVE is t if called interactively."
                  (buffer-substring-no-properties (point-min) (point-max))))))
 
 (defun eglot--after-change (start end length)
+  "Hook onto `after-change-functions'.
+Records START, END and LENGTH locally."
   (cl-incf eglot--versioned-identifier)
   (push (list start end length) eglot--recent-changes)
   ;; (eglot--message "start is %s, end is %s, length is %s" start end length)
   )
 
 (defun eglot--signalDidOpen ()
+  "Send textDocument/didOpen to server."
   (eglot--notify (eglot--current-process-or-lose)
                  :textDocument/didOpen
                  (eglot--obj :textDocument
                              (eglot--current-buffer-TextDocumentItem))))
 
 (defun eglot--signalDidClose ()
+  "Send textDocument/didClose to server."
   (eglot--notify (eglot--current-process-or-lose)
                  :textDocument/didClose
                  (eglot--obj :textDocument
                              (eglot--current-buffer-TextDocumentItem))))
 
 (defun eglot--maybe-signal-didChange ()
+  "Send textDocument/didChange to server."
   (when eglot--recent-changes
     (save-excursion
       (save-restriction



reply via email to

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