emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: windows.texi doc fix


From: David PONCE
Subject: Re: windows.texi doc fix
Date: Thu, 21 Oct 2004 12:31:00 +0200 (CEST)

> It is good to notice that this needed to be fixed, but the style that
> we use in doc strings is too terse and not correct enough for the
> manual.  The former uses incomplete sentences, such as this:
> 
>     + Optional third arg @var{preserve-before}, if address@hidden, means 
> 
> Could you please try rewriting this text using the style that we use
> for such cases elsewhere in the manual?  Please just try your best--I
> can polish it up after you install it.

OK.  WDYT of this version, which is much simpler.  As the
documentation explicitly says that `shrink-window' is like
`enlarge-window' but negates the size argument, I didn't duplicated
the description of `preserve-before'.

David

*** windows.texi.orig   2004-07-24 17:33:15.000000000 +0200
--- windows.texi        2004-10-21 12:32:38.681402600 +0200
***************
*** 1922,1928 ****
  window size.  Emacs does not permit overlapping windows or gaps between
  windows, so resizing one window affects other windows.
  
! @deffn Command enlarge-window size &optional horizontal
  This function makes the selected window @var{size} lines taller,
  stealing lines from neighboring windows.  It takes the lines from one
  window at a time until that window is used up, then takes from another.
--- 1922,1928 ----
  window size.  Emacs does not permit overlapping windows or gaps between
  windows, so resizing one window affects other windows.
  
! @deffn Command enlarge-window size &optional horizontal preserve-before
  This function makes the selected window @var{size} lines taller,
  stealing lines from neighboring windows.  It takes the lines from one
  window at a time until that window is used up, then takes from another.
***************
*** 1945,1950 ****
--- 1945,1955 ----
  size of a fixed-size window, @code{enlarge-window} gets an error
  instead.
  
+ If @var{preserve-before} is address@hidden, this function does not
+ changes the size of the siblings above or to the left of the selected
+ window.  Only the size of the siblings below or to the right of the
+ selected window are changed.
+ 
  If @var{size} is negative, this function shrinks the window by
  @address@hidden lines or columns.  If that makes the window smaller
  than the minimum size (@code{window-min-height} and
***************
*** 1965,1971 ****
  @end example
  @end deffn
  
! @deffn Command shrink-window size &optional horizontal
  This function is like @code{enlarge-window} but negates the argument
  @var{size}, making the selected window smaller by giving lines (or
  columns) to the other windows.  If the window shrinks below
--- 1970,1976 ----
  @end example
  @end deffn
  
! @deffn Command shrink-window size &optional horizontal preserve-before
  This function is like @code{enlarge-window} but negates the argument
  @var{size}, making the selected window smaller by giving lines (or
  columns) to the other windows.  If the window shrinks below





reply via email to

[Prev in Thread] Current Thread [Next in Thread]