unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: martin rudalics <rudalics@gmx.at>
Cc: emacs-devel@gnu.org
Subject: Re: Changes to windows.texi
Date: Sat, 08 Nov 2008 20:09:05 +0200	[thread overview]
Message-ID: <uvduyqeda.fsf@gnu.org> (raw)
In-Reply-To: <4914514C.9020700@gmx.at>

> Date: Fri, 07 Nov 2008 15:31:40 +0100
> From: martin rudalics <rudalics@gmx.at>
> 
> I now rewrote windows.texi a bit including the following changes:

Thanks.

> Thanks in advance to everyone who intends to polish up the style of
> these changes.

I made some corrections.

One problem that consistently shows up in your changes is demonstrated
by the following example:

  The selected window's buffer is usually the current buffer (except
  when @code{set-buffer} has been used), @xref{Current Buffer}.

This usage of @xref in the middle of a sentence produces badly
capitalized English, because @xref generates "See ..." with a capital
S.  The right way of writing this kind of text is either

  The selected window's buffer is usually the current buffer (except
  when @code{set-buffer} has been used), see @ref{Current Buffer}.

or

  The selected window's buffer is usually the current buffer (except
  when @code{set-buffer} has been used) (@pxref{Current Buffer}).

(The latter doesn't look good because of the other parenthesized text,
but that's another matter.)  I fixed all such invalid uses of @xref.

Another potential issue is as in this example, which is a full
sentence:

  @var{window} defaults to the selected window.

This makes "window", starting with a lower-case w, begin a sentence,
which might look like a typo in the printed manual.  (In the Info
manual, @var upcases its argument, so the problem is not visible.)
the original text was

  If @var{window} is omitted, this function returns the buffer for the
  selected window.

and thus didn't have this problem.  I didn't fix these sentences.

There are some changes whose motivation is unclear to me.  For
example, this change:

   @deffn Command switch-to-buffer-other-window buffer-or-name &optional norecord
  -This function makes @var{buffer-or-name} the current buffer and
  -displays it in a window not currently selected.  It then selects that
  -window.  The handling of the buffer is the same as in
  -@code{switch-to-buffer}.
  +This function makes @var{buffer-or-name} the current buffer, displays it
  +in a window not currently selected, and selects that window.  The
  +handling of the buffer is the same as in @code{switch-to-buffer}.

looks for the worse to me, because it made one complex sentence out of
2 simpler ones.

I also don't understand why you removed paragraph indentation as in
this example:

  -  Here is how you can determine whether a given position @var{position}
  -is off the screen due to horizontal scrolling:
  +Here is how you can determine whether a given position @var{position} is
  +off the screen due to horizontal scrolling:

I didn't fix these, either.




  reply	other threads:[~2008-11-08 18:09 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-11-07 14:31 Changes to windows.texi martin rudalics
2008-11-08 18:09 ` Eli Zaretskii [this message]
2008-11-08 19:56   ` martin rudalics
2008-11-08 20:16     ` Eli Zaretskii
2008-11-08 21:54       ` martin rudalics
2008-11-08 23:07         ` Eli Zaretskii
2008-11-09 15:13           ` Richard M. Stallman
2008-11-09 18:47             ` Eli Zaretskii
2008-11-10 19:28               ` Richard M. Stallman
2008-11-09 15:13   ` Richard M. Stallman
2008-11-09 21:23     ` Eli Zaretskii

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=uvduyqeda.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=rudalics@gmx.at \
    /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).