[Emacs-diffs] /srv/bzr/emacs/trunk r105911: Minor doc fixes for some window functions.

[Chong Yidong]

------------------------------------------------------------
revno: 105911
committer: Chong Yidong <address@hidden>
branch nick: trunk
timestamp: Sat 2011-09-24 18:51:36 -0400
message:
  Minor doc fixes for some window functions.
  
  Minor doc fixes for switch-to-buffer, window-prev-buffers,
  set-window-prev-buffers, set-window-next-buffers.
modified:
  lisp/window.el
  src/ChangeLog
  src/window.c

=== modified file 'lisp/window.el'
--- a/lisp/window.el    2011-09-23 01:42:40 +0000
+++ b/lisp/window.el    2011-09-24 22:51:36 +0000
@@ -4937,9 +4937,9 @@
 one.
 
 If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
-in the currently selected window; signal an error if that is
-impossible (e.g. if the selected window is minibuffer-only).
-If non-nil, BUFFER-OR-NAME may be displayed in another window.
+in the selected window; signal an error if that is
+impossible (e.g. if the selected window is minibuffer-only).  If
+non-nil, BUFFER-OR-NAME may be displayed in another window.
 
 Return the buffer switched to."
   (interactive

=== modified file 'src/ChangeLog'
--- a/src/ChangeLog     2011-09-24 18:29:35 +0000
+++ b/src/ChangeLog     2011-09-24 22:51:36 +0000
@@ -1,3 +1,8 @@
+2011-09-24  Chong Yidong  <address@hidden>
+
+       * window.c (Fwindow_prev_buffers, Fset_window_prev_buffers)
+       (Fset_window_next_buffers): Doc fix.
+
 2011-09-24  Glenn Morris  <address@hidden>
 
        * minibuf.c (read_minibuf): Disable line truncation.  (Bug#5715)

=== modified file 'src/window.c'
--- a/src/window.c      2011-09-09 01:06:52 +0000
+++ b/src/window.c      2011-09-24 22:51:36 +0000
@@ -1665,8 +1665,9 @@
        doc:  /* Return buffers previously shown in WINDOW.
 WINDOW must be a live window and defaults to the selected one.
 
-The return value is either nil or a list of <buffer, window-start,
-window-point> triples where buffer was previously shown in WINDOW.  */)
+The return value is a list of elements (BUFFER WINDOW-START POS),
+where BUFFER is a buffer, WINDOW-START is the start position of the
+window for that buffer, and POS is a window-specific point value.  */)
   (Lisp_Object window)
 {
   return decode_window (window)->prev_buffers;
@@ -1675,11 +1676,11 @@
 DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers,
        Sset_window_prev_buffers, 2, 2, 0,
        doc: /* Set WINDOW's previous buffers to PREV-BUFFERS.
-WINDOW must be a live window and defaults to the selected one.  Return
-PREV-BUFFERS.
+WINDOW must be a live window and defaults to the selected one.
 
-PREV-BUFFERS should be either nil or a list of <buffer, window-start,
-window-point> triples where buffer was previously shown in WINDOW.  */)
+PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS),
+where BUFFER is a buffer, WINDOW-START is the start position of the
+window for that buffer, and POS is a window-specific point value.  */)
      (Lisp_Object window, Lisp_Object prev_buffers)
 {
   return decode_window (window)->prev_buffers = prev_buffers;
@@ -1697,11 +1698,8 @@
 DEFUN ("set-window-next-buffers", Fset_window_next_buffers,
        Sset_window_next_buffers, 2, 2, 0,
        doc: /* Set WINDOW's next buffers to NEXT-BUFFERS.
-WINDOW must be a live window and defaults to the selected one.  Return
-NEXT-BUFFERS.
-
-NEXT-BUFFERS should be either nil or a list of buffers that have been
-recently re-shown in WINDOW.  */)
+WINDOW must be a live window and defaults to the selected one.
+NEXT-BUFFERS should be a list of buffers.  */)
      (Lisp_Object window, Lisp_Object next_buffers)
 {
   return decode_window (window)->next_buffers = next_buffers;