[elpa] externals/jit-spell c5957b71ad 2/7: Improve documentation of the process plist entries

[ELPA Syncer]

branch: externals/jit-spell
commit c5957b71ad3083709ba89e2d8047971c57f73373
Author: Augusto Stoffel <arstoffel@gmail.com>
Commit: Augusto Stoffel <arstoffel@gmail.com>

    Improve documentation of the process plist entries
---
 jit-spell.el | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/jit-spell.el b/jit-spell.el
index ddcd481e5b..7d2d450f6b 100644
--- a/jit-spell.el
+++ b/jit-spell.el
@@ -234,16 +234,26 @@ It can also be bound to a mouse click to pop up the menu."
 ;;; Subprocess communication
 
 (defun jit-spell--process-parameters ()
-  "Return a list of parameters for this buffer's ispell process.
-Buffers where this produces `equal' results will share their
-ispell process."
+  "Return a list of parameters for this buffer's ispell process."
   (list ispell-program-name
         ispell-current-dictionary
         ispell-current-personal-dictionary
         ispell-extra-args))
 
 (defun jit-spell--get-process ()
-  "Get an ispell process for the current buffer."
+  "Get an ispell process for the current buffer.
+Buffers where `jit-spell--process-parameters' returns the `equal'
+results share their ispell process.
+
+The process plist includes the following properties:
+
+`jit-spell--current request': a list of the form
+    (BUFFER TICK START END)
+  where TICK is used to keep track of the timeliness of the response.
+  Note that the process receives a single request at a time.
+
+`jit-spell--requests': a FIFO queue with elements in the same
+  form as above."
   (let* ((params (jit-spell--process-parameters))
          (proc (plist-get jit-spell--process-pool params #'equal)))
     (if (process-live-p proc)