From: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
To: Tomi Ollila <tomi.ollila@iki.fi>, notmuch@notmuchmail.org
Subject: Re: [PATCH] emacs docstrings: consistent indentation, newlines, periods
Date: Thu, 21 May 2020 17:47:45 -0400 [thread overview]
Message-ID: <875zcpj6ym.fsf@fifthhorseman.net> (raw)
In-Reply-To: <20200503212136.11070-1-tomi.ollila@iki.fi>
[-- Attachment #1.1: Type: text/plain, Size: 3042 bytes --]
On Mon 2020-05-04 00:21:36 +0300, Tomi Ollila wrote:
> Fixed emacs docstrings to be consistent. No functional change.
>
> - removed some (accidental) indentation
> - removed some trailing newlines
> - added trailing periods where missing (some exclusions)
This all looks good to me, except for the following changes.
I think if the last line of the docstring is an example, deliberately
indented to indicate that it is verbatim code, adding a trailing period
is a mistake, because it encourages naive users to make the obvious
error of including the period in their text.
These were the examples i noticed in a skim of the changeset:
> --- a/emacs/notmuch-draft.el
> +++ b/emacs/notmuch-draft.el
> @@ -45,7 +45,7 @@ (defcustom notmuch-draft-tags '("+draft")
> For example, if you wanted to give the message a \"draft\" tag
> but not the (normally added by default) \"inbox\" tag, you would
> set:
> - (\"+draft\" \"-inbox\")"
> + (\"+draft\" \"-inbox\")."
> :type '(repeat string)
> :group 'notmuch-draft)
>
> --- a/emacs/notmuch-lib.el
> +++ b/emacs/notmuch-lib.el
> @@ -145,7 +145,7 @@ (defcustom notmuch-archive-tags '("-inbox")
>
> For example, if you wanted to remove an \"inbox\" tag and add an
> \"archived\" tag, you would set:
> - (\"-inbox\" \"+archived\")"
> + (\"-inbox\" \"+archived\")."
> :type '(repeat string)
> :group 'notmuch-search
> :group 'notmuch-show)
> --- a/emacs/notmuch-message.el
> +++ b/emacs/notmuch-message.el
> @@ -33,7 +33,7 @@ (defcustom notmuch-message-replied-tags '("+replied")
>
> For example, if you wanted to add a \"replied\" tag and remove
> the \"inbox\" and \"todo\" tags, you would set:
> - (\"+replied\" \"-inbox\" \"-todo\")"
> + (\"+replied\" \"-inbox\" \"-todo\")."
> :type '(repeat string)
> :group 'notmuch-send)
>
> @@ -46,7 +46,7 @@ (defcustom notmuch-message-forwarded-tags '("+forwarded")
>
> For example, if you wanted to add a \"forwarded\" tag and remove
> the \"inbox\" tag, you would set:
> - (\"+forwarded\" \"-inbox\")"
> + (\"+forwarded\" \"-inbox\")."
> :type '(repeat string)
> :group 'notmuch-send)
> --- a/emacs/notmuch-show.el
> +++ b/emacs/notmuch-show.el
> @@ -237,7 +237,7 @@ (defcustom notmuch-show-mark-read-tags '("-unread")
>
> For example, if you wanted to remove an \"unread\" tag and add a
> \"read\" tag (which would make little sense), you would set:
> - (\"-unread\" \"+read\")"
> + (\"-unread\" \"+read\")."
> :type '(repeat string)
> :group 'notmuch-show)
I'd prefer this changeset to not have trailing periods when the
docstring ends in an example. (and maybe also to clean up any trailing
periods that might already be in such a docstring, if they exist)
I recognize this is something of an aesthetic position with no
objectively correct answer, but so is the question of trailing periods,
i suppose. I'm not going to die on this hill, though.
Regards,
--dkg
[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 227 bytes --]
[-- Attachment #2: Type: text/plain, Size: 0 bytes --]
next prev parent reply other threads:[~2020-05-21 21:48 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-03 21:21 [PATCH] emacs docstrings: consistent indentation, newlines, periods Tomi Ollila
2020-05-21 21:47 ` Daniel Kahn Gillmor [this message]
2020-05-21 22:08 ` Tomi Ollila
-- strict thread matches above, loose matches on Subject: below --
2020-05-24 19:17 Tomi Ollila
2020-06-06 11:50 ` David Bremner
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://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=875zcpj6ym.fsf@fifthhorseman.net \
--to=dkg@fifthhorseman.net \
--cc=notmuch@notmuchmail.org \
--cc=tomi.ollila@iki.fi \
/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://yhetil.org/notmuch.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).