# HG changeset patch # User Juanma Barranquero # Date 1184762430 0 # Node ID a09176483fa181f412a07da9db1d8ede1bd4349b # Parent 5929028583e4d25371ba2cdee63a420f7d157284 (follow-mode-hook, follow-mode-off-hook, follow-mode, follow-delete-other-windows-and-split, follow-recenter, follow-windows-aligned-p, follow-point-visible-all-windows-p, follow-redisplay, follow-estimate-first-window-start, follow-xemacs-scrollbar-support, follow-intercept-process-output): Fix typos in docstrings. diff -r 5929028583e4 -r a09176483fa1 lisp/follow.el --- a/lisp/follow.el Tue Jul 17 16:14:25 2007 +0000 +++ b/lisp/follow.el Wed Jul 18 12:40:30 2007 +0000 @@ -278,12 +278,12 @@ :group 'convenience) (defcustom follow-mode-hook nil - "Hooks to run when follow-mode is turned on." + "Hooks to run when Follow mode is turned on." :type 'hook :group 'follow) (defcustom follow-mode-off-hook nil - "Hooks to run when follow-mode is turned off." + "Hooks to run when Follow mode is turned off." :type 'hook :group 'follow) @@ -581,9 +581,9 @@ movement commands. Follow mode comes to its prime when used on a large screen and two -side-by-side window are used. The user can, with the help of Follow +side-by-side windows are used. The user can, with the help of Follow mode, use two full-height windows as though they would have been -one. Imagine yourself editing a large function, or section of text, +one. Imagine yourself editing a large function, or section of text, and being able to use 144 lines instead of the normal 72... (your mileage may vary). @@ -591,7 +591,7 @@ `\\[split-window-horizontally]' or \ `M-x follow-delete-other-windows-and-split' can be used. -Only windows displayed in the same frame follow each-other. +Only windows displayed in the same frame follow each other. If the variable `follow-intercept-processes' is non-nil, Follow mode will listen to the output of processes and redisplay accordingly. @@ -725,11 +725,11 @@ Execute this command to display as much as possible of the text in the selected window. All other windows, in the current frame, are deleted and the selected window is split in two -side-by-side windows. Follow Mode is activated, hence the +side-by-side windows. Follow Mode is activated, hence the two windows always will display two successive pages. \(If one window is moved, the other one will follow.) -If ARG is positive, the leftmost window is selected. If it negative, +If ARG is positive, the leftmost window is selected. If negative, the rightmost is selected. If ARG is nil, the leftmost window is selected if the original window is the first one in the frame. @@ -834,8 +834,8 @@ Rearrange all other windows around the middle window. With a positive argument, place the current line ARG lines -from the top. With a negative, place it -ARG lines from the -bottom." +from the top. With a negative argument, place it -ARG lines +from the bottom." (interactive "P") (if arg (let ((p (point)) @@ -1065,7 +1065,7 @@ ;; should start at a full screen line. (defsubst follow-windows-aligned-p (win-start-end) - "Non-nil if the follower WINDOWS are aligned." + "Non-nil if the follower windows are aligned." (let ((res t)) (save-excursion (goto-char (window-start (car (car win-start-end)))) @@ -1085,7 +1085,7 @@ ;; no one will be recentered.) (defun follow-point-visible-all-windows-p (win-start-end) - "Non-nil when the window-point is visible in all windows." + "Non-nil when the `window-point' is visible in all windows." (let ((res t)) (while (and res win-start-end) (setq res (follow-pos-visible (window-point (car (car win-start-end))) @@ -1213,7 +1213,7 @@ (defun follow-redisplay (&optional windows win) "Reposition the WINDOWS around WIN. Should the point be too close to the roof we redisplay everything -from the top. WINDOWS should contain a list of windows to +from the top. WINDOWS should contain a list of windows to redisplay, it is assumed that WIN is a member of the list. Should WINDOWS be nil, the windows displaying the same buffer as WIN, in the current frame, are used. @@ -1294,8 +1294,8 @@ (defun follow-estimate-first-window-start (windows win start) "Estimate the position of the first window. -Returns (EXACT . POS). If EXACT is non-nil, POS is the starting -position of the first window. Otherwise it is a good guess." +Returns (EXACT . POS). If EXACT is non-nil, POS is the starting +position of the first window. Otherwise it is a good guess." (let ((pred (car (follow-split-followers windows win))) (exact nil)) (save-excursion @@ -1747,7 +1747,7 @@ (defun follow-xemacs-scrollbar-support (window) "Redraw windows showing the same buffer as shown in WINDOW. WINDOW is either the dragged window, or a cons containing the -window as its first element. This is called while the user drags +window as its first element. This is called while the user drags the scrollbar. WINDOW can be an object or a window." @@ -1877,7 +1877,7 @@ "Intercept all active processes. This is needed so that Follow Mode can track all display events in the -system. (See `follow-mode')" +system. (See `follow-mode'.)" (interactive) (let ((list (process-list))) (while list @@ -2084,8 +2084,8 @@ (defun follow-window-size-change (frame) "Redraw all windows in FRAME, when in Follow mode." - ;; Below, we call `post-command-hook'. This makes sure that we - ;; doesn't start a mutally recursive endless loop. + ;; Below, we call `post-command-hook'. This makes sure that we + ;; don't start a mutually recursive endless loop. (if follow-inside-post-command-hook nil (let ((buffers '()) @@ -2155,7 +2155,7 @@ ;;{{{ Tail window handling ;; In Emacs (not XEmacs) windows showing nothing are sometimes -;; recentered. When in Follow Mode, this is not desireable for +;; recentered. When in Follow Mode, this is not desirable for ;; non-first windows in the window chain. This section tries to ;; make the windows stay where they should be. ;;