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

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


        Stefan



       reply	other threads:[~2015-09-05 15:27 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   ` Stefan Monnier [this message]
2015-09-05 20:38     ` [elpa] master a79dd37 07/11: fsm: Fix checkdoc errors Thomas Fitzsimmons
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=jwv4mj8horj.fsf-monnier+emacsdiffs@gnu.org \
    --to=monnier@iro.umontreal.ca \
    --cc=emacs-devel@gnu.org \
    --cc=fitzsim@fitzsim.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.