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

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

[Stefan Kangas]

[-- Attachment #1: Type: text/plain, Size: 276 bytes --]

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

[-- Attachment #2: 0001-Fix-typo-in-doc-string-of-file-exists-p.patch --]
[-- Type: application/x-patch, Size: 963 bytes --]

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

[Eli Zaretskii]

> From: Stefan Kangas <stefan@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.

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

[Richard Stallman]

[[[ 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)

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

[Eli Zaretskii]

> From: Richard Stallman <rms@gnu.org>
> Cc: stefan@marxist.se, 36408@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.

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

[Drew Adams]

> > -       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.