added doc strings to popup menu functions and lem-process:run-process

* added doc strings to popup menu functions

* added documentation for lem-process:run-process

* updated formatting

* fixed typo

Author: ethanxxxl

extensions/process/process.lisp

@@ -25,6 +25,25 @@
     :reader process-output-callback-type)))
 
 (defun run-process (command &key name output-callback output-callback-type directory)
+  "Runs an external program as a separate thread.
+- `command`: can simply be a string naming the command to run.  If you need to
+  pass arguments to the command, then `command` must be a list of strings.  Each string will be its own
+  arg.  These args are not parsed by a shell, so you cannot combine tokens, such as a flag and its value.
+
+  for example, `find ~ -iname \"lem\"` would be represented as
+  '(\"find\" \"~\" \"-iname\" \"\\\"lem\\\"\")
+
+- `name`: You can supply a detailed name.  The command name is used by default.
+
+- `output-callback`: if `output-callback-type` is `:process-input`, then `output-callback`
+  must be a function with the lambda list `(process string)`.  Otherwise, it must only take 
+  a single argument (string).  This is called whenever the process sends input to its stdout.
+  The process output can also be retrieved by `lem-process:get-process-output-string`.
+
+- `output-callback-type`: If set to `:process-input`, `output-callback` takes `(process string)`.
+  otherwise, it takes `(string)`
+
+- `directory`: Specifies where to look for `command`.  if not specified, PATH is used."
   (setf command (uiop:ensure-list command))
   (let ((buffer-stream (make-string-output-stream)))
     (let* ((pointer (async-process:create-process command :nonblock nil :directory directory))

src/ext/popup-menu.lisp

@@ -35,9 +35,9 @@
   (make-line-overlay point focus-attribute))
 
 (defun update-focus-overlay (popup-menu point)
-+  "Refresh the focus highlight so it tracks POINT in POPUP-MENU.
-+Deletes any previous overlay, clears stray overlays, and creates a new
-+focus overlay unless POINT is on the header line."
+  "Refresh the focus highlight so it tracks POINT in POPUP-MENU.
+Deletes any previous overlay, clears stray overlays, and creates a new
+focus overlay unless POINT is on the header line."
   (alexandria:when-let ((focus-overlay (popup-menu-focus-overlay popup-menu)))
     (delete-overlay focus-overlay))
   (clear-overlays (popup-menu-buffer popup-menu))
@@ -49,6 +49,8 @@
   (:method (print-spec point)))
 
 (defgeneric apply-print-spec (print-spec point item)
+  (:documentation "Applies the function `print-spec` to an `item` at `point`.  Typically this
+will get the string representation of `item` and insert it at `point` (the default method implemented below)")
   (:method ((print-spec function) point item)
     (let ((string (funcall print-spec item)))
       (insert-string point string))))

src/popup.lisp

@@ -38,6 +38,14 @@
                                 print-spec
                                 style
                                 max-display-items)
+  "Creates a popup-menu at the cursor position and displays it.  Used for things
+ such as completions.
+
+  - `items`: is a list of anything, but print-spec must be able to turn it into a string.
+  - `action-callback`: function taking an item (from `items`) as a parameter.  It is run once an item is selected.
+  - `print-spec`: A function taking an `item` as a paremeter and returns it's string representation.
+  - `style`: No Documentation
+  - `max-display-items`: integer limiting the number of items that can be displayed at once."
   (declare (ignore action-callback print-spec style max-display-items))
   (apply #'lem-if:display-popup-menu (implementation)
          items