From: Stefan Kangas <stefankangas@gmail.com>
To: Michael Albinus <Michael.Albinus@gmx.de>
Cc: emacs-devel@gnu.org
Subject: Re: master 838e6cae81: ; * etc/NEWS: Fix typos.
Date: Fri, 16 Sep 2022 10:01:27 -0400 [thread overview]
Message-ID: <CADwFkm=tTvbrP3NRMUsqkwsV2R0Y6jpQcnTE3ueVGMcCFbq1ag@mail.gmail.com> (raw)
In-Reply-To: <87tu57samv.fsf@gmx.de>
Michael Albinus <Michael.Albinus@gmx.de> writes:
> Yes, I've discussed this with Eli some weeks ago, and he does agree. It
> is just a matter of time for implementation. Something like checkdoc, ideally.
>
> If you want to beat me (much appreciated!) I append my blurb for
> checking. Just some code fragments, unordered.
Thanks, that sounds great. I won't beat you to it, in all likelihood,
but any progress you can make here is much appreciated.
Maybe this could eventually be extended into checking also doc/**/*texi
for similar style errors? Or perhaps, for some of them, in the entire
tree?
Some minor comments:
> ** Don't use "behaviour" or "colour"
>
> grep --color=auto -nH --null -E 'behaviour|colour' NEWS
I should generally catch these (and more, see commit ba0871bef1e7) in my
periodic runs of codespell, but it can't hurt to have extra checks in
place. Perhaps I could document how I use codespell on the Emacs
sources, if that is of interest.
> ** Check for "it's", it must be "it is"
>
> (occur "it's" nil)
Do we accept "don't" and "can't"? I believe they are also frowned upon
in formal writing. (And what about "hasn't", and "haven't", etc.?)
> ** Check for "filename", it must be "file name"
>
> (occur "filename" nil)
>
> ** Check for "doc string", it must be "docstring"
>
> (occur "doc[[:space:]]+string" nil)
Also:
"data base" -> "database"
next prev parent reply other threads:[~2022-09-16 14:01 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <166333363759.20767.6682542392675900101@vcs2.savannah.gnu.org>
[not found] ` <20220916130718.0C2F6C026E1@vcs2.savannah.gnu.org>
2022-09-16 13:27 ` master 838e6cae81: ; * etc/NEWS: Fix typos Stefan Kangas
2022-09-16 13:37 ` Michael Albinus
2022-09-16 14:01 ` Stefan Kangas [this message]
2022-09-16 14:06 ` Michael Albinus
2022-09-16 15:12 ` Stefan Monnier
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CADwFkm=tTvbrP3NRMUsqkwsV2R0Y6jpQcnTE3ueVGMcCFbq1ag@mail.gmail.com' \
--to=stefankangas@gmail.com \
--cc=Michael.Albinus@gmx.de \
--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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.