# HG changeset patch # User Juanma Barranquero # Date 1121944151 0 # Node ID 4b552d6938e8d7f2a50efefa358a2a2971fbbb5e # Parent 3a895c8815ed7fb53b7ee4d18878953eca5ae14f (vcursor-other-window, vcursor-bind-keys, vcursor-key-bindings, vcursor-use-vcursor-map, vcursor-find-window, vcursor-scroll-down, vcursor-disable, vcursor-beginning-of-buffer, vcursor-end-of-buffer): Fix typos in docstrings. (vcursor-relative-move, vcursor-get-char-count): Improve argument/docstring consistency. diff -r 3a895c8815ed -r 4b552d6938e8 lisp/vcursor.el --- a/lisp/vcursor.el Thu Jul 21 10:51:10 2005 +0000 +++ b/lisp/vcursor.el Thu Jul 21 11:09:11 2005 +0000 @@ -356,7 +356,7 @@ (defun vcursor-bind-keys (var value) "Alter the value of the variable VAR to VALUE, binding keys as required. -VAR is usually vcursor-key-bindings. Normally this function is called +VAR is usually `vcursor-key-bindings'. Normally this function is called on loading vcursor and from the customize package." (set var value) (cond @@ -464,8 +464,8 @@ (defcustom vcursor-key-bindings nil "*How to bind keys when vcursor is loaded. -If t, guess; if xterm, use bindings suitable for an X terminal; if -oemacs, use bindings which work on a PC with Oemacs. If nil, don't +If t, guess; if `xterm', use bindings suitable for an X terminal; if +`oemacs', use bindings which work on a PC with Oemacs. If nil, don't define any key bindings. Default is nil." @@ -514,7 +514,7 @@ (defvar vcursor-use-vcursor-map nil "Non-nil if the vcursor map is mapped directly onto the main keymap. -See vcursor-toggle-vcursor-map.") +See `vcursor-toggle-vcursor-map'.") (make-variable-buffer-local 'vcursor-use-vcursor-map) (defvar vcursor-map nil "Keymap for vcursor command.") @@ -575,7 +575,7 @@ With NEW-WIN non-nil, display the virtual cursor buffer in another window if the virtual cursor is not currently visible \(note, however, -that this function never changes window-point\). +that this function never changes `window-point'\). With THIS-FRAME non-nil, don't search other frames for a new window \(though if the vcursor is already off-frame then its current window is @@ -674,15 +674,15 @@ (insert text)) ) -(defun vcursor-relative-move (fn &rest args) - "Use FUNCTION with arbitrary ARG1 ... to move the virtual cursor. +(defun vcursor-relative-move (func &rest args) + "Call FUNC with arbitrary ARGS ... to move the virtual cursor. This is called by most of the virtual-cursor motion commands." (let (text opoint) (save-excursion (vcursor-locate) (setq opoint (point)) - (apply fn args) + (apply func args) (and (eq opoint (point-max)) (eq opoint (point)) (signal 'end-of-buffer nil)) (vcursor-move (point)) @@ -730,7 +730,7 @@ ) (defun vcursor-scroll-down (&optional n) - "Scroll down the vcursor window ARG lines or near-full screen if none. + "Scroll down the vcursor window ARG lines or near full screen if none. The vcursor will always appear in an unselected window." (interactive "P") @@ -791,10 +791,10 @@ (setq vcursor-last-command t) ) -(defun vcursor-get-char-count (fn &rest args) - "Apply FN to ARG1 ... and return the number of characters moved. -Point is temporarily set to the virtual cursor position before FN is -called. +(defun vcursor-get-char-count (func &rest args) + "Apply FUNC to ARGS ... and return the number of characters moved. +Point is temporarily set to the virtual cursor position before FUNC +is called. This is called by most of the virtual-cursor copying commands to find out how much to copy." @@ -803,7 +803,7 @@ (save-excursion (set-buffer (overlay-buffer vcursor-overlay)) (let ((start (goto-char (overlay-start vcursor-overlay)))) - (- (progn (apply fn args) (point)) start))) + (- (progn (apply func args) (point)) start))) ) ;; Make sure the virtual cursor is active. Unless arg is non-nil, @@ -822,13 +822,12 @@ With a positive prefix ARG, the first window in cyclic order displaying the virtual cursor (or which was recently displaying the -virtual cursor) will be deleted unless it's the selected -window. +virtual cursor) will be deleted unless it's the selected window. With a negative prefix argument, enable the virtual cursor: make it active at the same point as the real cursor. -Copying mode is always turned off: the next use of the vcursor will +Copying mode is always turned off: the next use of the vcursor will not copy text until you turn it on again." (interactive "P") @@ -854,7 +853,7 @@ virtual cursor, or else after the current selected window. If there is no other window, the current window is split. -Arguments N and optional ALL-FRAMES are the same as with other-window. +Arguments N and optional ALL-FRAMES are the same as with `other-window'. ALL-FRAMES is also used to decide whether to split the window." (interactive "p") @@ -1042,7 +1041,7 @@ (defun vcursor-beginning-of-buffer (&optional arg) "Move the virtual cursor to the beginning of its buffer. -ARG is as for beginning-of-buffer." +ARG is as for `beginning-of-buffer'." (interactive "P") (vcursor-relative-move (lambda (arg) @@ -1053,7 +1052,7 @@ (defun vcursor-end-of-buffer (&optional arg) "Move the virtual cursor to the end of its buffer. -ARG is as for end-of-buffer. +ARG is as for `end-of-buffer'. Actually, the vcursor is moved to the second from last character or it would be invisible."