all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Thomas Fitzsimmons <fitzsim@fitzsim.org>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: emacs-devel@gnu.org
Subject: Re: [elpa] master a79dd37 07/11: fsm: Fix checkdoc errors
Date: Sat, 05 Sep 2015 16:38:55 -0400	[thread overview]
Message-ID: <m3wpw48uu8.fsf@fitzsim.org> (raw)
In-Reply-To: <jwv4mj8horj.fsf-monnier+emacsdiffs@gnu.org> (Stefan Monnier's message of "Sat, 05 Sep 2015 11:27:06 -0400")

Stefan Monnier <monnier@iro.umontreal.ca> writes:

>> -  "Send EVENT to FSM asynchronously.
>> +  "Send FSM EVENT asynchronously.
>
> Hmm... was that because checkdoc asked you to put the args in the order
> of appearance?

Yes, I was trying to make fsm.el "checkdoc-clean".

> I think this part of checkdoc's recommendations is not to be taken
> too seriously.
> It's OK to follow this principle for things like
>
>    Arg FOO does toto.
>    Arg BAR does titi.
>
> But clarity of the text takes precedence.

OK, I reverted these parts, including the last one where I liked the
previous wording better.

Thomas



  reply	other threads:[~2015-09-05 20:38 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20150905100513.2686.25389@vcs.savannah.gnu.org>
     [not found] ` <E1ZYALU-0000jJ-Dz@vcs.savannah.gnu.org>
2015-09-05 15:27   ` [elpa] master a79dd37 07/11: fsm: Fix checkdoc errors Stefan Monnier
2015-09-05 20:38     ` Thomas Fitzsimmons [this message]
2015-09-06 22:40       ` 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=m3wpw48uu8.fsf@fitzsim.org \
    --to=fitzsim@fitzsim.org \
    --cc=emacs-devel@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    /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.