GNU bug report logs - #36408
[PATCH] Fix typo in doc string of file-exists-p

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 36408 in the body.
You can then email your comments to 36408 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] Fix typo in doc string of file-exists-p
Date: Fri, 28 Jun 2019 02:12:32 +0200

[Message part 1 (text/plain, inline)]

Please see the attached small fix, making sure the first line is a
complete sentence.

-       doc: /* Return t if file FILENAME exists (whether or not you
can read it.)
+       doc: /* Return t if file FILENAME exists (whether or not you
can read it).

Thanks,
Stefan Kangas

[0001-Fix-typo-in-doc-string-of-file-exists-p.patch (application/x-patch, attachment)]

Message #8 received at 36408 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 36408 <at> debbugs.gnu.org
Subject: Re: bug#36408: [PATCH] Fix typo in doc string of file-exists-p
Date: Fri, 28 Jun 2019 09:33:35 +0300

> From: Stefan Kangas <stefan <at> marxist.se>
> Date: Fri, 28 Jun 2019 02:12:32 +0200
> 
> Please see the attached small fix, making sure the first line is a
> complete sentence.
> 
> -       doc: /* Return t if file FILENAME exists (whether or not you
> can read it.)
> +       doc: /* Return t if file FILENAME exists (whether or not you
> can read it).

AFAIK, this is a long-standing stylistic issue.  I'm not sure what
people prefer or whether we should insist on consistency in these
cases.

Message #11 received at 36408 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Eli Zaretskii <eliz <at> gnu.org>, Stefan Kangas <stefan <at> marxist.se>
Cc: 36408 <at> debbugs.gnu.org
Subject: RE: bug#36408: [PATCH] Fix typo in doc string of file-exists-p
Date: Fri, 28 Jun 2019 08:38:55 -0700 (PDT)

> > -       doc: /* Return t if file FILENAME exists (whether or not you
> > can read it.)
> > +       doc: /* Return t if file FILENAME exists (whether or not you
> > can read it).
> 
> AFAIK, this is a long-standing stylistic issue.  I'm not sure what
> people prefer or whether we should insist on consistency in these
> cases.

FWIW: There's no stylistic issue here.  The first
is incorrect; the second is correct.  You won't
find any style guide that would opt for or approve
of the former: "___ ___ (__ __.)".  That's not even
a sentence.

Message #14 received at 36408 <at> debbugs.gnu.org (full text, mbox):

From: Richard Stallman <rms <at> gnu.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: stefan <at> marxist.se, 36408 <at> debbugs.gnu.org
Subject: Re: bug#36408: [PATCH] Fix typo in doc string of file-exists-p
Date: Fri, 28 Jun 2019 23:19:03 -0400

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

  > > -       doc: /* Return t if file FILENAME exists (whether or not you
  > > can read it.)
  > > +       doc: /* Return t if file FILENAME exists (whether or not you
  > > can read it).

In this case, the latter is correct.  You put a period inside the
parentheses only when its contents consist of complete sentences.

-- 
Dr Richard Stallman
President, Free Software Foundation (https://gnu.org, https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)

Message #19 received at 36408-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: rms <at> gnu.org
Cc: stefan <at> marxist.se, 36408-done <at> debbugs.gnu.org
Subject: Re: bug#36408: [PATCH] Fix typo in doc string of file-exists-p
Date: Sat, 29 Jun 2019 10:38:42 +0300

> From: Richard Stallman <rms <at> gnu.org>
> Cc: stefan <at> marxist.se, 36408 <at> debbugs.gnu.org
> Date: Fri, 28 Jun 2019 23:19:03 -0400
> 
>   > > -       doc: /* Return t if file FILENAME exists (whether or not you
>   > > can read it.)
>   > > +       doc: /* Return t if file FILENAME exists (whether or not you
>   > > can read it).
> 
> In this case, the latter is correct.  You put a period inside the
> parentheses only when its contents consist of complete sentences.

Thanks, I pushed Stefan's patch to the emacs-26 branch.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.