Commit ad22b7f7 authored by Juanma Barranquero's avatar Juanma Barranquero
Browse files

lisp/avoid.el: Fix typos in docstrings.

parent 6efb972c
2011-03-12 Juanma Barranquero <lekktu@gmail.com>
* avoid.el (mouse-avoidance-mode, mouse-avoidance-nudge-dist)
(mouse-avoidance-threshold, mouse-avoidance-banish-destination)
(mouse-avoidance-mode): Fix typos in docstrings.
2011-03-12 Michael Albinus <michael.albinus@gmx.de>
* net/tramp.el (tramp-progress-reporter-update): Use
......
......@@ -77,7 +77,7 @@
;;;###autoload
(defcustom mouse-avoidance-mode nil
"Activate mouse avoidance mode.
"Activate Mouse Avoidance mode.
See function `mouse-avoidance-mode' for possible values.
Setting this variable directly does not take effect;
use either \\[customize] or the function `mouse-avoidance-mode'."
......@@ -86,8 +86,7 @@ use either \\[customize] or the function `mouse-avoidance-mode'."
(mouse-avoidance-mode (or value 'none)))
:initialize 'custom-initialize-default
:type '(choice (const :tag "none" nil) (const banish) (const jump)
(const animate) (const exile) (const proteus)
)
(const animate) (const exile) (const proteus))
:group 'avoid
:require 'avoid
:version "20.3")
......@@ -95,7 +94,7 @@ use either \\[customize] or the function `mouse-avoidance-mode'."
(defcustom mouse-avoidance-nudge-dist 15
"Average distance that mouse will be moved when approached by cursor.
Only applies in Mouse-Avoidance mode `jump' and its derivatives.
Only applies in Mouse Avoidance mode `jump' and its derivatives.
For best results make this larger than `mouse-avoidance-threshold'."
:type 'integer
:group 'avoid)
......@@ -113,7 +112,7 @@ For best results make this larger than `mouse-avoidance-threshold'."
(defcustom mouse-avoidance-threshold 5
"Mouse-pointer's flight distance.
If the cursor gets closer than this, the mouse pointer will move away.
Only applies in mouse-avoidance-modes `animate' and `jump'."
Only applies in Mouse Avoidance modes `animate' and `jump'."
:type 'integer
:group 'avoid)
......@@ -184,7 +183,7 @@ Acceptable distance is defined by `mouse-avoidance-threshold'."
mouse-avoidance-threshold))))))
(defun mouse-avoidance-banish-destination ()
"The position to which Mouse-Avoidance mode `banish' moves the mouse.
"The position to which Mouse Avoidance mode `banish' moves the mouse.
You can redefine this if you want the mouse banished to a different corner."
(let* ((pos (window-edges)))
(cons (- (nth 2 pos) 2)
......@@ -332,7 +331,7 @@ redefine this function to suit your own tastes."
;;;###autoload
(defun mouse-avoidance-mode (&optional mode)
"Set cursor avoidance mode to MODE.
"Set Mouse Avoidance mode to MODE.
MODE should be one of the symbols `banish', `exile', `jump', `animate',
`cat-and-mouse', `proteus', or `none'.
......@@ -352,7 +351,7 @@ Effects of the different modes:
Whenever the mouse is moved, the frame is also raised.
\(see `mouse-avoidance-threshold' for definition of \"too close\",
\(See `mouse-avoidance-threshold' for definition of \"too close\",
and `mouse-avoidance-nudge-dist' and `mouse-avoidance-nudge-var' for
definition of \"random distance\".)"
(interactive
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment