all: various doc fixes.

2 files changed, 11 insertions, 11 deletions

diff --git a/lava-jobs.el b/lava-jobs.el
index 4073037..e04f2fd 100644
--- a/lava-jobs.el
+++ b/lava-jobs.el
@@ -40,7 +40,7 @@
 (defvar lava-job-info
   nil
   "Association list of job info hashes, indexed by lava-job-%d
-  symbols.")
+symbols.")
 
 (defun lava-jobs-make-index (jobspec-or-id)
   "Return a unique symbol for a given jobspec-or-id for use in the
@@ -96,7 +96,7 @@
       nil)))
 
 (defun lava-jobs-find-running-job-by-name (name)
-  "Return a list of running jobs that match the job description."
+  "Return a list of running jobs that match the `NAME' as the job description."
   (-filter
    (lambda (job)
      (let* ((info-hash (lava-jobs-get-hash job))
@@ -109,11 +109,11 @@
 ;(lava-jobs-find-running-job-by-name "mustang-hacking-session")
 
 (defun lava-jobs-filter-by-state (state list-of-jobs)
-  "Return a list of jobs in a given state"
+  "Return a list of jobs in a given state."
   (--filter (string-match-p state (lava-jobs-get-field it "job_status")) list-of-jobs))
 
 (defun lava-jobs-find-latest-running (list-of-jobs)
-  "Return the latest running job of a list of jobs"
+  "Return the latest running job of from `LIST-OF-JOBS'."
   (let ((running-jobs (lava-jobs-filter-by-state "Running"
                                                  list-of-jobs)))
     (when running-jobs
@@ -122,7 +122,7 @@
                   (time-less-p other-time it-time))
                 running-jobs))))
 
-; (lava-jobs-find-latest-running (lava-jobs-find-running-job-by-name "mustang-cloudimg-hacking-session"))
+; (lava-jobs-find-latest-running (lava-jobs-find-running-job-by-name "mustang-hacking-session"))
 
 (provide 'lava-jobs)
 ;;; lava-jobs.el ends here
diff --git a/lava-mode.el b/lava-mode.el
index a6f8529..ee13dee 100644
--- a/lava-mode.el
+++ b/lava-mode.el
@@ -158,7 +158,7 @@ lisp."
       (let ((last-pos (point)))
         (while (re-search-forward lava-mode-elisp-escape-regex nil t)
           (goto-char (match-beginning 1))
-                                        ; copy-to here verbatim
+          ;; copy-to here verbatim
           (let ((last-chunk
                  (buffer-substring
                   last-pos
@@ -185,7 +185,7 @@ lisp."
         (-map #'(lambda (i) (cdr (assoc "name" i))) list)))
 
 (defun lava-mode--get-device-list ()
-  "Fetch the latest device list"
+  "Fetch the latest device list."
   (lava-rpc-get-device-list 'lava-mode--update-device-list))
 
 (defun lava-mode-select-device ()
@@ -230,7 +230,7 @@ first device in the list."
           (json-encode-list '(("command" . "boot_linaro_image")))))))))
 
 (defun lava-mode-test-repository ()
-  "Return the current test repository"
+  "Return the current test repository."
   lava-mode-test-repository)
 
 (defun lava-mode-get-pubkey ()
@@ -238,7 +238,7 @@ first device in the list."
   (s-trim (shell-command-to-string "cat ~/.ssh/id_rsa.pub")))
 
 (defun lava-mode-end-of-day-timeout (&optional end-of-day)
-  "Return the number of seconds until the end of the working day.
+  "Return the number of seconds until the `END-OF-DAY'.
 This is intended to ensure hacking sessions don't hang around for too
   long but also you don't end up leaving big timeouts in your
   definitions."
@@ -256,7 +256,7 @@ This is intended to ensure hacking sessions don't hang around for too
       secs)))
 
 (defun lava-mode-find-latest-file (path pattern &optional nth)
-  "Find the latest file matching `PATTERN' at `PATH'.
+  "Search `PATH' to find the latest file matching `PATTERN' (optionally `NTH').
 If `nth' is defined then find the nth latest file"
   (let* ((all-files (directory-files path t pattern)))
     (file-name-nondirectory
@@ -266,7 +266,7 @@ If `nth' is defined then find the nth latest file"
                                        (nth 5 (file-attributes fileB))))) all-files)))))
 
 (defun lava-mode-device-running-latest (name-or-list-of-names)
-  "Return the device which is running the latest version of `NAME'"
+  "Return the device which is running the latest version of `NAME'."
   (let* ((jobs
           (if (stringp name-or-list-of-names)
               (lava-jobs-find-running-job-by-name name-or-list-of-names)