GNU bug report logs -
#12973
@: overused in manual
Previous Next
Reported by: Paul Eggert <eggert <at> cs.ucla.edu>
Date: Fri, 23 Nov 2012 19:27:01 UTC
Severity: minor
Tags: patch
Done: Paul Eggert <eggert <at> cs.ucla.edu>
Bug is archived. No further changes may be made.
To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 12973 in the body.
You can then email your comments to 12973 AT debbugs.gnu.org in the normal way.
Toggle the display of automated, internal messages from the tracker.
Report forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Fri, 23 Nov 2012 19:27:01 GMT)
Full text and
rfc822 format available.
Acknowledgement sent
to
Paul Eggert <eggert <at> cs.ucla.edu>
:
New bug report received and forwarded. Copy sent to
bug-gnu-emacs <at> gnu.org
.
(Fri, 23 Nov 2012 19:27:02 GMT)
Full text and
rfc822 format available.
Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):
[Message part 1 (text/plain, inline)]
Tags: patch
Severity: minor
The Emacs manual uses "@:" in many places where it needn't.
Sometimes the @: has no effect, e.g., "Jay K.@: Adams".
Other times, it's being used in places where punctuation
would be better, e.g., "(e.g.@: spaces)". I'm attaching a
proposed patch.
[at-colon.txt.gz (application/x-gzip, attachment)]
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Fri, 23 Nov 2012 19:49:02 GMT)
Full text and
rfc822 format available.
Message #8 received at 12973 <at> debbugs.gnu.org (full text, mbox):
> Date: Fri, 23 Nov 2012 11:25:21 -0800
> From: Paul Eggert <eggert <at> cs.ucla.edu>
>
> The Emacs manual uses "@:" in many places where it needn't.
> Sometimes the @: has no effect, e.g., "Jay K.@: Adams".
Why do you say it has no effect in this case?
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Fri, 23 Nov 2012 20:53:02 GMT)
Full text and
rfc822 format available.
Message #11 received at 12973 <at> debbugs.gnu.org (full text, mbox):
On 11/23/2012 11:46 AM, Eli Zaretskii wrote:
> Why do you say it has no effect in this case?
It has no effect in TeX because TeX already does
the right thing with initials. TeX assumes that
"." ends a sentence unless it's preceded by a capital
letter. "Jay K. Adams" has a capital letter before
the period so no @: is needed after the period.
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Fri, 23 Nov 2012 21:49:01 GMT)
Full text and
rfc822 format available.
Message #14 received at 12973 <at> debbugs.gnu.org (full text, mbox):
> Date: Fri, 23 Nov 2012 12:50:34 -0800
> From: Paul Eggert <eggert <at> cs.ucla.edu>
> CC: 12973 <at> debbugs.gnu.org
>
> On 11/23/2012 11:46 AM, Eli Zaretskii wrote:
> > Why do you say it has no effect in this case?
>
> It has no effect in TeX because TeX already does
> the right thing with initials. TeX assumes that
> "." ends a sentence unless it's preceded by a capital
> letter. "Jay K. Adams" has a capital letter before
> the period so no @: is needed after the period.
This ought to be in the Texinfo manual, then. I suggest to report
this to Texinfo maintainers, because the latest manual doesn't mention
that.
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Fri, 23 Nov 2012 23:54:02 GMT)
Full text and
rfc822 format available.
Message #17 received at 12973 <at> debbugs.gnu.org (full text, mbox):
On Fri, 23 Nov 2012 12:50:34 -0800 Paul Eggert <eggert <at> cs.ucla.edu> wrote:
> On 11/23/2012 11:46 AM, Eli Zaretskii wrote:
>> Why do you say it has no effect in this case?
>
> It has no effect in TeX because TeX already does
> the right thing with initials. TeX assumes that
> "." ends a sentence unless it's preceded by a capital
> letter. "Jay K. Adams" has a capital letter before
> the period so no @: is needed after the period.
What does TeX do with sentences like these:
"Mary would never do that, nor would I. Would you?"
"We met the mysterious Madame X. She's younger than I thought."
"Walk ten paces to point A. Turn left, then walk 7 paces to point B."
Steve Berman
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Fri, 23 Nov 2012 23:58:01 GMT)
Full text and
rfc822 format available.
Message #20 received at 12973 <at> debbugs.gnu.org (full text, mbox):
On 11/23/2012 03:51 PM, Stephen Berman wrote:
> What does TeX do with sentences like these:
>
> "Mary would never do that, nor would I. Would you?"
> "We met the mysterious Madame X. She's younger than I thought."
> "Walk ten paces to point A. Turn left, then walk 7 paces to point B."
It assumes that "I.", "X.", "A.", and "B." do not end sentences.
To fix this in Texinfo, use "I@." instead of "I.", and similarly
for the others.
This is documented in the Texinfo manual, though apparently the
documentation isn't clear enough.
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sat, 24 Nov 2012 00:14:02 GMT)
Full text and
rfc822 format available.
Message #23 received at 12973 <at> debbugs.gnu.org (full text, mbox):
On Fri, 23 Nov 2012 15:56:08 -0800 Paul Eggert <eggert <at> cs.ucla.edu> wrote:
> On 11/23/2012 03:51 PM, Stephen Berman wrote:
>> What does TeX do with sentences like these:
>>
>> "Mary would never do that, nor would I. Would you?"
>> "We met the mysterious Madame X. She's younger than I thought."
>> "Walk ten paces to point A. Turn left, then walk 7 paces to point B."
>
> It assumes that "I.", "X.", "A.", and "B." do not end sentences.
> To fix this in Texinfo, use "I@." instead of "I.", and similarly
> for the others.
>
> This is documented in the Texinfo manual, though apparently the
> documentation isn't clear enough.
I hadn't actually looked before, but I just did, and it's quite clear in
(texinfo)Ending a Sentence.
Steve Berman
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sat, 24 Nov 2012 01:46:02 GMT)
Full text and
rfc822 format available.
Message #26 received at 12973 <at> debbugs.gnu.org (full text, mbox):
It has no effect in TeX because TeX already does
the right thing with initials. TeX assumes that
"." ends a sentence unless it's preceded by a capital
letter. "Jay K. Adams" has a capital letter before
the period so no @: is needed after the period.
Maybe other Texinfo formatters do not treat the capital letter as
special.
--
Dr Richard Stallman
President, Free Software Foundation
51 Franklin St
Boston MA 02110
USA
www.fsf.org www.gnu.org
Skype: No way! That's nonfree (freedom-denying) software.
Use Ekiga or an ordinary phone call
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sat, 24 Nov 2012 02:06:01 GMT)
Full text and
rfc822 format available.
Message #29 received at 12973 <at> debbugs.gnu.org (full text, mbox):
Paul Eggert wrote:
> Other times, it's being used in places where punctuation
> would be better, e.g., "(e.g.@: spaces)".
Stylistically, I prefer the current form in at least some cases.
Anyway, I think a patch of this kind if applied to trunk is likely to
lead to repeated merge conflicts coming from emacs-24. So maybe wait
till there is no active branch.
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sat, 24 Nov 2012 06:34:02 GMT)
Full text and
rfc822 format available.
Message #32 received at 12973 <at> debbugs.gnu.org (full text, mbox):
> From: Stephen Berman <stephen.berman <at> gmx.net>
> Cc: Eli Zaretskii <eliz <at> gnu.org>, 12973 <at> debbugs.gnu.org
> Date: Sat, 24 Nov 2012 01:11:53 +0100
>
> On Fri, 23 Nov 2012 15:56:08 -0800 Paul Eggert <eggert <at> cs.ucla.edu> wrote:
>
> > On 11/23/2012 03:51 PM, Stephen Berman wrote:
> >> What does TeX do with sentences like these:
> >>
> >> "Mary would never do that, nor would I. Would you?"
> >> "We met the mysterious Madame X. She's younger than I thought."
> >> "Walk ten paces to point A. Turn left, then walk 7 paces to point B."
> >
> > It assumes that "I.", "X.", "A.", and "B." do not end sentences.
> > To fix this in Texinfo, use "I@." instead of "I.", and similarly
> > for the others.
> >
> > This is documented in the Texinfo manual, though apparently the
> > documentation isn't clear enough.
>
> I hadn't actually looked before, but I just did, and it's quite clear in
> (texinfo)Ending a Sentence.
But if one looks up @:, which is in another section, they will not see
that "X." doesn't need a @:. And that is a problem, because "Not
Ending a Sentence" should have pointed to "Ending a Sentence" or told
explicitly that @: is not required in those cases.
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sat, 24 Nov 2012 06:35:01 GMT)
Full text and
rfc822 format available.
Message #35 received at 12973 <at> debbugs.gnu.org (full text, mbox):
> From: Glenn Morris <rgm <at> gnu.org>
> Date: Fri, 23 Nov 2012 21:03:33 -0500
> Cc: 12973 <at> debbugs.gnu.org
>
> Paul Eggert wrote:
>
> > Other times, it's being used in places where punctuation
> > would be better, e.g., "(e.g.@: spaces)".
>
> Stylistically, I prefer the current form in at least some cases.
Me too (which isn't surprising, since I wrote some of them ;-).
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sat, 24 Nov 2012 06:48:02 GMT)
Full text and
rfc822 format available.
Message #38 received at 12973 <at> debbugs.gnu.org (full text, mbox):
> maybe wait till there is no active branch.
Yes, it sounds good to wait.
>> Stylistically, I prefer the current form in at least some cases.
> Me too (which isn't surprising, since I wrote some of them ;-).
I got the suggestion of putting a comma after "i.e." and after "e.g."
from RMS, many years ago. RMS's style agrees with that of the
Chicago Manual of Style, the Columbia Guide to Standard American
English, the Lynch Guide to Grammar, and the Blue Book on Grammar
and Punctuation, among others.
American style guides seem to prefer the commas almost universally.
British guides are not that way (Fowler 3rd, in particular, says to omit
comma after i.e.; it says nothing about e.g.). The Emacs manual
is written in American English, though, not in British English.
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sat, 24 Nov 2012 07:47:01 GMT)
Full text and
rfc822 format available.
Message #41 received at 12973 <at> debbugs.gnu.org (full text, mbox):
> Date: Fri, 23 Nov 2012 22:45:40 -0800
> From: Paul Eggert <eggert <at> cs.ucla.edu>
> CC: Glenn Morris <rgm <at> gnu.org>, 12973 <at> debbugs.gnu.org
>
> American style guides seem to prefer the commas almost universally.
> British guides are not that way (Fowler 3rd, in particular, says to omit
> comma after i.e.; it says nothing about e.g.). The Emacs manual
> is written in American English, though, not in British English.
It is pointless to argue about personal style preferences.
In any case, in my experience, this kind of changes is quickly made
futile by future changes to the manuals that re-introduce comma-less
e.g. and i.e. back into the text. So if we want to adhere to the
style that prefers the comma, we should IMO install some change that
enforces these rules, to be run at "make info" time and flag any
deviations.
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sat, 24 Nov 2012 15:19:01 GMT)
Full text and
rfc822 format available.
Message #44 received at 12973 <at> debbugs.gnu.org (full text, mbox):
> In any case, in my experience, this kind of changes is quickly made
> futile by future changes to the manuals that re-introduce comma-less
> e.g. and i.e. back into the text. So if we want to adhere to the
> style that prefers the comma, we should IMO install some change that
> enforces these rules, to be run at "make info" time and flag any
> deviations.
And I think we had better just ignore those differences and move on.
Enforcing such rules is a waste of time.
Stefan
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sat, 24 Nov 2012 15:47:02 GMT)
Full text and
rfc822 format available.
Message #47 received at 12973 <at> debbugs.gnu.org (full text, mbox):
> From: Stefan Monnier <monnier <at> iro.umontreal.ca>
> Cc: Paul Eggert <eggert <at> cs.ucla.edu>, 12973 <at> debbugs.gnu.org
> Date: Sat, 24 Nov 2012 10:17:02 -0500
>
> > In any case, in my experience, this kind of changes is quickly made
> > futile by future changes to the manuals that re-introduce comma-less
> > e.g. and i.e. back into the text. So if we want to adhere to the
> > style that prefers the comma, we should IMO install some change that
> > enforces these rules, to be run at "make info" time and flag any
> > deviations.
>
> And I think we had better just ignore those differences and move on.
Ignore them and install the changes proposed by Paul, or ignore them
and don't install?
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sat, 24 Nov 2012 18:39:02 GMT)
Full text and
rfc822 format available.
Message #50 received at 12973 <at> debbugs.gnu.org (full text, mbox):
But if one looks up @:, which is in another section, they will not see
that "X." doesn't need a @:. And that is a problem, because "Not
Ending a Sentence" should have pointed to "Ending a Sentence" or told
explicitly that @: is not required in those cases.
I explicitly decided NOT to say this. I don't remember for certain
why I made that decision, but it was not an omission. Maybe it
was to simplify the rules for Texinfo; maybe it is for some
other formatter's sake.
--
Dr Richard Stallman
President, Free Software Foundation
51 Franklin St
Boston MA 02110
USA
www.fsf.org www.gnu.org
Skype: No way! That's nonfree (freedom-denying) software.
Use Ekiga or an ordinary phone call
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sat, 24 Nov 2012 18:40:02 GMT)
Full text and
rfc822 format available.
Message #53 received at 12973 <at> debbugs.gnu.org (full text, mbox):
Consistent style and proper usage do not alone make a manual good, but
the lack of them makes any manual worse. We should correct these
style issues for each Emacs release.
It would be good to invite some people who are good at this
to do the work and install the fixes directly.
--
Dr Richard Stallman
President, Free Software Foundation
51 Franklin St
Boston MA 02110
USA
www.fsf.org www.gnu.org
Skype: No way! That's nonfree (freedom-denying) software.
Use Ekiga or an ordinary phone call
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sat, 24 Nov 2012 20:33:02 GMT)
Full text and
rfc822 format available.
Message #56 received at 12973 <at> debbugs.gnu.org (full text, mbox):
On 11/23/2012 05:43 PM, Richard Stallman wrote:
> Maybe other Texinfo formatters do not treat the capital letter as
> special.
As far as I know, they're all consistent in this matter,
i.e., all formatters treat the "Q." in "John Q. Smith"
as not ending a sentence, and none of them insert extra
space after the "Q.".
In hindsight, perhaps Texinfo should also have been consistent
about the way that it formats "Write it in C. The compile it."
That is, perhaps it should have formatted that "C.<space><space>"
as end of sentence, regardless of what TeX would do with the same
input. But I suppose it's too late to change that now.
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sat, 24 Nov 2012 20:37:02 GMT)
Full text and
rfc822 format available.
Message #59 received at 12973 <at> debbugs.gnu.org (full text, mbox):
> Ignore them and install the changes proposed by Paul, or ignore them
> and don't install?
Whichever gets us to "move on" more quickly.
Stefan
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sat, 24 Nov 2012 20:42:01 GMT)
Full text and
rfc822 format available.
Message #62 received at 12973 <at> debbugs.gnu.org (full text, mbox):
> Date: Sat, 24 Nov 2012 13:37:14 -0500
> From: Richard Stallman <rms <at> gnu.org>
> CC: stephen.berman <at> gmx.net, eggert <at> cs.ucla.edu, 12973 <at> debbugs.gnu.org
>
> But if one looks up @:, which is in another section, they will not see
> that "X." doesn't need a @:. And that is a problem, because "Not
> Ending a Sentence" should have pointed to "Ending a Sentence" or told
> explicitly that @: is not required in those cases.
>
> I explicitly decided NOT to say this. I don't remember for certain
> why I made that decision, but it was not an omission.
That suggests we shouldn't make those parts of the proposed changes,
where initials are involved.
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sun, 25 Nov 2012 00:49:01 GMT)
Full text and
rfc822 format available.
Message #65 received at 12973 <at> debbugs.gnu.org (full text, mbox):
[Message part 1 (text/plain, inline)]
On 11/24/2012 10:37 AM, Richard Stallman wrote:
> We should correct these style issues for each Emacs release.
Our release strategy makes it difficult to fix these style
changes now: if we made changes like these, either to
the trunk or to the emacs-24 branch, that'd make it harder
to merge other emacs-24 changes into the trunk later. For
this reason it's been suggested that I hold off on changes
like these, I guess until after the next Emacs release.
While we're on the topic, the Emacs manual has similar problems with
"@.". Sometimes it uses "@." when it's not necessary, or even
incorrect (the attached patch at-dot1.txt fixes instances of this
that I found). More often, the manual incorrectly omits "@."
(see attached patch at-dot.txt.gz).
I'm attaching a combined patch at-combined.txt.gz to make it
easier for me to remember about installing these patches later.
I'm not installing these patches now, though, for the reasons
discussed above.
[at-dot1.txt (text/plain, attachment)]
[at-dot.txt.gz (application/x-gzip, attachment)]
[at-combined.txt.gz (application/x-gzip, attachment)]
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sun, 25 Nov 2012 04:49:02 GMT)
Full text and
rfc822 format available.
Message #68 received at 12973 <at> debbugs.gnu.org (full text, mbox):
> We should correct these style issues for each Emacs release.
Our release strategy makes it difficult to fix these style
changes now: if we made changes like these, either to
the trunk or to the emacs-24 branch, that'd make it harder
to merge other emacs-24 changes into the trunk later.
I don't think we are talking about the same thing.
You seem to be criticizing a specific plan for installing the changes
into the Bzr repository. I'm not talking about mechanics like that.
I'm saying that someone should edit the manual for style and usage for
each release. Precisely when in the release style is a detail that I
leave to others, but I would normally do it before making a separate
branch for a given release. If it is done after that, the changes
should be installed in both the trunk and the branch.
While we're on the topic, the Emacs manual has similar problems with
"@.". Sometimes it uses "@." when it's not necessary,
An unnecessary use of @. is not an error.
--
Dr Richard Stallman
President, Free Software Foundation
51 Franklin St
Boston MA 02110
USA
www.fsf.org www.gnu.org
Skype: No way! That's nonfree (freedom-denying) software.
Use Ekiga or an ordinary phone call
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sun, 25 Nov 2012 19:18:01 GMT)
Full text and
rfc822 format available.
Message #71 received at 12973 <at> debbugs.gnu.org (full text, mbox):
Paul Eggert wrote:
> Our release strategy makes it difficult to fix these style changes
> now: if we made changes like these, either to the trunk or to the
> emacs-24 branch, that'd make it harder to merge other emacs-24 changes
> into the trunk later.
There's zero problem wrt merging if the changes go to emacs-24 now.
If they go trunk, they will probably create repeated merge annoyances
(like any pervasive formatting change would).
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Sun, 25 Nov 2012 19:19:01 GMT)
Full text and
rfc822 format available.
Message #74 received at 12973 <at> debbugs.gnu.org (full text, mbox):
Richard Stallman wrote:
> I'm saying that someone should edit the manual for style and usage for
> each release.
People do.
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#12973
; Package
emacs
.
(Mon, 26 Nov 2012 01:34:02 GMT)
Full text and
rfc822 format available.
Message #77 received at 12973 <at> debbugs.gnu.org (full text, mbox):
Glenn Morris wrote:
> There's zero problem wrt merging if the changes go to emacs-24 now.
In fact I suggest you just do that so that we can stop discussing this.
Reply sent
to
Paul Eggert <eggert <at> cs.ucla.edu>
:
You have taken responsibility.
(Wed, 05 Dec 2012 22:32:01 GMT)
Full text and
rfc822 format available.
Notification sent
to
Paul Eggert <eggert <at> cs.ucla.edu>
:
bug acknowledged by developer.
(Wed, 05 Dec 2012 22:32:02 GMT)
Full text and
rfc822 format available.
Message #82 received at 12973-done <at> debbugs.gnu.org (full text, mbox):
On 11/25/12 17:31, Glenn Morris wrote:
> In fact I suggest you just do that so that we can stop discussing this.
Done, as emacs-24 bzr 110998, and I'm
marking this bug as done.
bug archived.
Request was from
Debbugs Internal Request <help-debbugs <at> gnu.org>
to
internal_control <at> debbugs.gnu.org
.
(Thu, 03 Jan 2013 12:24:04 GMT)
Full text and
rfc822 format available.
This bug report was last modified 11 years and 346 days ago.
Previous Next
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.