[STUMP] [PATCH] Nitpicky documentation updates.

[Scott Wolchok]

---
 frame.lisp          |    6 +++---
 group.lisp          |    8 ++++----
 input.lisp          |   12 ++++++------
 message-window.lisp |    4 ++--
 primitives.lisp     |   21 ++++++++++-----------
 screen.lisp         |    4 ++--
 selection.lisp      |    4 ++--
 stumpwm.texi.in     |   18 ++++++++++--------
 user.lisp           |    9 +++++----
 window.lisp         |    3 ++-
 wrappers.lisp       |    2 +-
 11 files changed, 47 insertions(+), 44 deletions(-)

diff --git a/frame.lisp b/frame.lisp
index 666b0e7..25b828e 100644
--- a/frame.lisp
+++ b/frame.lisp
@@ -808,7 +808,7 @@ the current frame."
  (focus-next-frame (current-group)))

 (defcommand sibling () ()
-"Jump to the frame's sibling. If a frame is split into twe frames,
+"Jump to the frame's sibling. If a frame is split into two frames,
 these two frames are siblings."
  (focus-frame-next-sibling (current-group)))

@@ -833,8 +833,8 @@ select one. Returns the selected frame or nil if aborted."


 (defcommand fselect (frame-number) ((:frame t))
-"Display a number in the corner of each frame and let the user to
-select a frame by number. If @var{frame-number} is specified, just
+"Display a number in the corner of each frame and let the user select
+a frame by typing its number. If @var{frame-number} is specified, just
 jump to that frame."
  (let ((group (current-group)))
    (focus-frame group frame-number)))
diff --git a/group.lisp b/group.lisp
index 424dc88..1ed7134 100644
--- a/group.lisp
+++ b/group.lisp
@@ -244,9 +244,9 @@ Groups are known as \"virtual desktops\" in the
NETWM standard."

 (defcommand gnew (name) ((:string "Group Name: "))
 "Create a new group with the specified name. The new group becomes the
-current group. If @var{name} begins with a dot (``.'') the group new
-group will be created in the hidden state. Hidden groups have group
-numbers less than one and are invisible to from gprev, gnext, and, optionally,
+current group. If @var{name} begins with a dot (``.'') the new group
+will be created in the hidden state. Hidden groups have group numbers
+less than one and are invisible to gprev, gnext, and, optionally,
 groups and vgroups commands."
  (let ((group (add-group (current-screen) name)))
    (if group
@@ -330,7 +330,7 @@ the default group formatting and window
formatting, respectively."

 (defcommand grouplist (&optional (fmt *group-format*)) (:rest)
  "Allow the user to select a group from a list, like windowlist but
-  for groups"
+  for groups."
  (let ((group (second (select-from-menu
               (current-screen)
               (mapcar (lambda (g)
diff --git a/input.lisp b/input.lisp
index 0171b92..de6b661 100644
--- a/input.lisp
+++ b/input.lisp
@@ -92,7 +92,7 @@
  "The current index in the current completions list.")

 (defvar *input-history-ignore-duplicates* nil
-  "Do not add a command to the input history if it's already the
first in the list.")
+  "If true, do not add a command to the input history if it's already
the first in the list.")

 ;;; keysym functions

@@ -182,8 +182,8 @@

 (defun completing-read (screen prompt completions &optional (initial-input ""))
  "Read a line of input through stumpwm and return it with TAB
-completion. completions can be a list, an fbound symbol, or a
-function. if its an fbound symbol or a function then that
+completion. A completion can be a list, an fbound symbol, or a
+function. If it's an fbound symbol or a function, then that
 function is passed the substring to complete on and is expected
 to return a list of matches."
  (check-type completions (or list function symbol))
@@ -193,7 +193,7 @@ to return a list of matches."
    (read-one-line screen prompt initial-input)))

 (defun read-one-line (screen prompt &optional (initial-input ""))
-  "Read a line of input through stumpwm and return it. returns nil if
the user aborted."
+  "Read a line of input through stumpwm and return it. Return nil if
the user aborted."
  (let ((*input-last-command* nil)
        (input (make-input-line :string (make-input-string initial-input)
                                :position (length initial-input)
@@ -301,7 +301,7 @@ to return a list of matches."
  (throw :abort nil))

 (defun input-goto-char (input point)
-  "Move the cursor to the specified point in the string"
+  "Move the cursor to the specified point in the string."
  (setf (input-line-position input) (min (max 0 point)
                                         (length (input-line-string input)))))

@@ -320,7 +320,7 @@ functions are passed this structure as their first
argument."

 (defun input-validate-region (input start end)
  "Return a value pair of numbers where the first number is < the
-second and neither excedes the bounds of the input string."
+second and neither exceeds the bounds of the input string."
  (values (max 0 (min start end))
          (min (length (input-line-string input))
               (max start end))))
diff --git a/message-window.lisp b/message-window.lisp
index c7e4b00..a231908 100644
--- a/message-window.lisp
+++ b/message-window.lisp
@@ -227,11 +227,11 @@ function expects to be wrapped in a with-state for win."
    (apply 'run-hook-with-args *message-hook* strings)))

 (defun echo-string (screen msg)
-  "Display @var{string} in the message bar on @var{screen}. You
almost always want to use @command{message}."
+  "Display @var{msg} in the message bar on @var{screen}. You almost
always want to use @command{message} instead."
  (echo-string-list screen (split-string msg (string #\Newline))))

 (defun message (fmt &rest args)
-  "run FMT and ARGS through `format' and echo the result to the
current screen."
+  "Run FMT and ARGS through `format' and echo the result to the
current screen."
  (echo-string (current-screen) (apply 'format nil fmt args)))


diff --git a/primitives.lisp b/primitives.lisp
index 0a20305..28d7c30 100644
--- a/primitives.lisp
+++ b/primitives.lisp
@@ -753,8 +753,8 @@ characters.")
  "An alist of characters and formatter functions. The character can be
 used as a format character in @var{*group-format*}. When the character
 is encountered in the string, the corresponding function is called
-with a group as an argument. The functions return value is inserted
-into the string. If the return value isn't a string it is converted to
+with a group as an argument. The function's return value is inserted
+into the string. If the return value isn't a string, it is converted to
 one using @code{prin1-to-string}.")

 (defvar *group-format* "%n%s%t"
@@ -846,17 +846,16 @@ ITEM. Return the new list."

 (defvar *min-frame-width* 50
  "The minimum width a frame can be. A frame will not shrink below this
-width. Splitting will not affect frames if the new frame widths are
+width. Splitting will not affect frames if the new frame widths would be
 less than this value.")

 (defvar *min-frame-height* 50
  "The minimum height a frame can be. A frame will not shrink below this
-height. Splitting will not affect frames if the new frame heights are
+height. Splitting will not affect frames if the new frame heights would be
 less than this value.")

 (defvar *new-frame-action* :last-window
-  "When a new frame is created, this variable controls what is put in the
-new frame. Valid values are
+  "What to put in a newly-created frame. Valid values are

 @table @code
 @item :empty
@@ -899,10 +898,10 @@ window, and returns the preferred frame or a
list of the above preferences.")
 suppress.")

 (defvar *default-package* (find-package "CL-USER")
-  "This is the package eval reads and executes in. You might want to set
-this to @code{:stumpwm} if you find yourself using a lot of internal
-stumpwm symbols. Setting this variable anywhere but in your rc file
-will have no effect.")
+  "This is the package eval reads and executes in. You might want to
+set this to @code{(find-package \"STUMPWM\")} if you find yourself
+using a lot of internal stumpwm symbols. Setting this variable
+anywhere but in your rc file will have no effect.")

 (defun concat (&rest strings)
  (apply 'concatenate 'string strings))
@@ -965,7 +964,7 @@ input focus is transfered to the window you click on.")
 within an interactive call to a command.")

 (defvar *window-border-style* :thick
-  "This controls the appearance of the border around windows. valid
+  "This controls the appearance of the border around windows. Valid
 values are:
 @table @var
 @item :thick
diff --git a/screen.lisp b/screen.lisp
index 6192406..70ddc32 100644
--- a/screen.lisp
+++ b/screen.lisp
@@ -167,11 +167,11 @@ identity with a range check."
    (move-screen-to-head screen)))

 (defun screen-current-window (screen)
-  "Return the current window on the specified screen"
+  "Return the current window on the specified screen."
  (group-current-window (screen-current-group screen)))

 (defun current-window ()
-  "Return the current window on the current screen"
+  "Return the current window on the current screen."
  (screen-current-window (current-screen)))

 (defun register-window (window)
diff --git a/selection.lisp b/selection.lisp
index 2da2adb..a25333c 100644
--- a/selection.lisp
+++ b/selection.lisp
@@ -66,7 +66,7 @@
  (xlib:display-finish-output *display*))

 (defun get-x-selection (&optional timeout)
-  "Return the x selection no matter what client own it."
+  "Return the X selection no matter what client owns it."
  (labels ((wait-for-selection (&rest event-slots &key display
event-key &allow-other-keys)
             (declare (ignore display))
             (when (eq event-key :selection-notify)
@@ -99,6 +99,6 @@
  (message "~a" (get-x-selection)))

 (defcommand copy-last-message () ()
-  "Copy the last message displayed into the X selection"
+  "Copy the last message displayed into the X selection."
  (when (screen-last-msg (current-screen))
    (set-x-selection (uncolorify (format nil "~{~a~^~%~}" (car
(screen-last-msg (current-screen))))))))
diff --git a/stumpwm.texi.in b/stumpwm.texi.in
index cb72115..5c47e69 100644
--- a/stumpwm.texi.in
+++ b/stumpwm.texi.in
@@ -206,7 +206,7 @@ with the actual path.
 @item
 Finally, start X windows with @command{startx}. Cross your
 fingers. You should see a @samp{Welcome To the Stump Window Manager}
-message pop up in the upper, right corner. At this point, you have
+message pop up in the upper-right corner. At this point, you have
 successfully started StumpWM.
 @end enumerate

@@ -255,8 +255,8 @@ For a full list of key bindings, @xref{List of
Default Keybindings}.
 @node Interacting with the Lisp process, Contact the StumpWM
developers, Basic Usage, Introduction
 @section Interacting with the Lisp process

-Since StumpWM is a Lisp program, there is a way for youto evaluate
-Lisp code directly, on the same Lisp process that StumpWM is running on.
+Since StumpWM is a Lisp program, there is a way for you to evaluate Lisp
+code directly, on the same Lisp process that StumpWM is running on.
 Type @kbd{C-t :} and an input box will appear. Then type some Lisp
 expression.

@@ -422,7 +422,7 @@ input history moved through.

 @item C-t :
 Opens the input box, but all things typed in here will be sent to the
-Common Lisp interpreter where they will be ran as Lisp programs; thus,
+Common Lisp interpreter where they will be run as Lisp programs; thus,
 input should be valid Common Lisp.

 @item C-t C-h
@@ -692,7 +692,7 @@ An input function takes 2 arguments: the input
structure and the key pressed.

 ### *window-format*
 ### *window-name-source*
-### *new-window-prefered-frame*
+### *new-window-preferred-frame*

 @menu
 * Window Marks::
@@ -887,8 +887,9 @@ positioning at the top or bottom of the head
rather than relying on
 @var{*mode-line-position*}

 The mode line can be turned on and off with the @command{mode-line}
-command or the lisp function @code{stumpwm:toggle-mode-line}. Each
-head has its own mode line. For example:
+command or the lisp function @code{stumpwm:toggle-mode-line}. It can be
+enabled with @code{stumpwm:enable-mode-line}. Each head has its own mode
+line. For example:

 @example
 ;; turn on/off the mode line for the current head only.
@@ -911,6 +912,7 @@ might do the following:

 !!! mode-line

+@@@ enable-mode-line
 @@@ toggle-mode-line

 ### *screen-mode-line-format*
@@ -976,7 +978,7 @@ StumpWM handles multiple screens.
 StumpWM will attempt to detect Xinerama heads at startup (and at no other
 time.) Heads are logically contained by screens. In a dual-monitor Xinerama
 configuration, there will be one screen with two heads. Non-rectangular layouts
-are supported (frames will not be created in the 'dead zone'.) And message
+are supported (frames will not be created in the 'dead zone'), and message
 windows will be displayed on the current head--that is, the head to which the
 currently focused frame belongs.

diff --git a/user.lisp b/user.lisp
index b1371f4..839d816 100644
--- a/user.lisp
+++ b/user.lisp
@@ -85,7 +85,7 @@ menu, the error is re-signalled."
    (warp-pointer (group-screen group) x y)))

 (defcommand banish (&optional where) (:rest)
-  "Warp the mouse the lower right corner of the current head."
+  "Warp the mouse pointer to the lower right corner of the current head."
  (if where
      (banish-pointer (intern (string-upcase where) :keyword))
      (banish-pointer)))
@@ -233,7 +233,7 @@ the 'date' command options except the following
ones: %g, %G, %j, %N,
 (defcommand-alias time echo-date)

 (defun programs-in-path (&optional full-path (path (split-string
(getenv "PATH") ":")))
-  "Return a list of programs in the path that start with @var{base}. if
+  "Return a list of programs in the path that start with @var{base}. If
 @var{full-path} is @var{t} then return the full path, otherwise just
 return the filename. @var{path} is by default the @env{PATH}
 evironment variable but can be specified. It should be a string containing
@@ -278,8 +278,8 @@ with base. Automagically update the cache."

 (defcommand run-shell-command (cmd &optional collect-output-p)
((:shell "/bin/sh -c "))
  "Run the specified shell command. If @var{collect-output-p} is @code{T}
-then run the command synchonously and collect the output. Be
-careful. If the shell command doesn't return, it will hang StumpWM. In
+then run the command synchronously and collect the output. Be
+careful: if the shell command doesn't return, it will hang StumpWM. In
 such a case, kill the shell command to resume StumpWM."
  (if collect-output-p
      (run-prog-collect-output *shell-program* "-c" cmd)
@@ -288,6 +288,7 @@ such a case, kill the shell command to resume StumpWM."
 (defcommand-alias exec run-shell-command)

 (defcommand eval-line (cmd) ((:rest "Eval: "))
+  "Evaluate @var{cmd} in the stumpwm lisp process as lisp code."
  (handler-case
      (message "^20~{~a~^~%~}"
               (mapcar 'prin1-to-string
diff --git a/window.lisp b/window.lisp
index dc60c29..ecdf115 100644
--- a/window.lisp
+++ b/window.lisp
@@ -1266,12 +1266,13 @@ is using the number, then the windows swap
numbers. Defaults to current group."
 (defcommand-alias number renumber)

 (defcommand gravity (gravity) ((:gravity "Gravity: "))
+"Set the current window's gravity to @var{gravity}."
  (when (current-window)
    (setf (window-gravity (current-window)) gravity)
    (maximize-window (current-window))))

 (defcommand windowlist (&optional (fmt *window-format*)) (:rest)
-"Allow the user to Select a window from the list of windows and focus
+"Allow the user to select a window from the list of windows and focus
 the selected window. For information of menu bindings
 @xref{Menus}. The optional argument @var{fmt} can be specified to
 override the default window formatting."
diff --git a/wrappers.lisp b/wrappers.lisp
index 1109c76..be8d768 100644
--- a/wrappers.lisp
+++ b/wrappers.lisp
@@ -116,7 +116,7 @@
  (error 'not-implemented :proc (list 'getenv var)))

 (defun (setf getenv) (val var)
-  "Set the value of the environment variable, @var{var} to @var{val}."
+  "Set the value of the environment variable @var{var} to @var{val}."
  #+allegro (setf (sys::getenv (string var)) (string val))
  #+clisp (setf (ext:getenv (string var)) (string val))
  #+(or cmu scl)
--
1.5.5.4