* Re: [elpa] master a79dd37 07/11: fsm: Fix checkdoc errors
[not found] ` <E1ZYALU-0000jJ-Dz@vcs.savannah.gnu.org>
@ 2015-09-05 15:27 ` Stefan Monnier
2015-09-05 20:38 ` Thomas Fitzsimmons
0 siblings, 1 reply; 3+ messages in thread
From: Stefan Monnier @ 2015-09-05 15:27 UTC (permalink / raw)
To: emacs-devel; +Cc: Thomas Fitzsimmons
> - "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
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [elpa] master a79dd37 07/11: fsm: Fix checkdoc errors
2015-09-05 15:27 ` [elpa] master a79dd37 07/11: fsm: Fix checkdoc errors Stefan Monnier
@ 2015-09-05 20:38 ` Thomas Fitzsimmons
2015-09-06 22:40 ` Stefan Monnier
0 siblings, 1 reply; 3+ messages in thread
From: Thomas Fitzsimmons @ 2015-09-05 20:38 UTC (permalink / raw)
To: Stefan Monnier; +Cc: emacs-devel
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
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [elpa] master a79dd37 07/11: fsm: Fix checkdoc errors
2015-09-05 20:38 ` Thomas Fitzsimmons
@ 2015-09-06 22:40 ` Stefan Monnier
0 siblings, 0 replies; 3+ messages in thread
From: Stefan Monnier @ 2015-09-06 22:40 UTC (permalink / raw)
To: Thomas Fitzsimmons; +Cc: emacs-devel
> Yes, I was trying to make fsm.el "checkdoc-clean".
I think this is indeed desirable in theory, but Someone™ should first
tweak checkdoc to remove some of the more debatable recommendations (at
least in its default state). IIRC another example is the recommendation
to name boolean vars with a "-flag" suffix (which I think is a poor
idea).
Stefan
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2015-09-06 22:40 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[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
2015-09-06 22:40 ` Stefan Monnier
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.