# HG changeset patch # User Martin Rudalics # Date 1225277788 0 # Node ID ce3730476c2a3963a3d31fd62ed8aa0997a12afb # Parent 01e8c1513572dfac4b5c1905283c4947effe2264 (Fwindow_height, Fdelete_window, set_window_buffer) (Fwindow_text_height): Clarify doc-strings. diff -r 01e8c1513572 -r ce3730476c2a src/window.c --- a/src/window.c Wed Oct 29 10:42:31 2008 +0000 +++ b/src/window.c Wed Oct 29 10:56:28 2008 +0000 @@ -505,8 +505,10 @@ } DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0, - doc: /* Return the number of lines in WINDOW (including its mode line). -WINDOW defaults to the selected window. */) + doc: /* Return the number of lines in WINDOW. +WINDOW defaults to the selected window. + +The return value includes WINDOW's mode line and header line, if any. */) (window) Lisp_Object window; { @@ -1510,7 +1512,9 @@ } DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "", - doc: /* Remove WINDOW from the display. Default is selected window. */) + doc: /* Remove WINDOW from its frame. +WINDOW defaults to the selected window. Return nil. +Signal an error when WINDOW is the only window on its frame. */) (window) register Lisp_Object window; { @@ -3514,7 +3518,8 @@ buffer (that is `window-dedicated-p' returns t for WINDOW) and does not already display BUFFER-OR-NAME. -This function runs the hook `window-scroll-functions'. */) +This function runs `window-scroll-functions' before running +`window-configuration-change-hook'. */) (window, buffer_or_name, keep_margins) register Lisp_Object window, buffer_or_name, keep_margins; { @@ -5765,8 +5770,9 @@ 0, 1, 0, doc: /* Return the height in lines of the text display area of WINDOW. WINDOW defaults to the selected window. -This doesn't include the mode-line (or header-line if any) or any -partial-height lines in the text display area. */) + +The return value does neither include the mode line or header line, if +any, nor any partial-height lines in the text display area. */) (window) Lisp_Object window; {