unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: David PONCE <david.ponce@wanadoo.fr>
Cc: emacs-devel@gnu.org
Subject: Re: windows.texi doc fix
Date: Thu, 21 Oct 2004 12:31:00 +0200 (CEST)	[thread overview]
Message-ID: <29461185.1098354660491.JavaMail.www@wwinf0203> (raw)

> 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 non-@code{nil}, 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 non-@code{nil}, 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
  @minus{}@var{size} 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	other threads:[~2004-10-21 10:31 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2004-10-21 10:31 David PONCE [this message]
2004-10-22 10:46 ` windows.texi doc fix Richard Stallman
  -- strict thread matches above, loose matches on Subject: below --
2004-10-19 10:11 david.ponce
2004-10-21  1:46 ` Richard Stallman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=29461185.1098354660491.JavaMail.www@wwinf0203 \
    --to=david.ponce@wanadoo.fr \
    --cc=emacs-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).