Re: documentation style - 2nd/3rd person tense for function comments
[
Date Prev][
Date Next][
Thread Prev][
Thread Next]
[
Date Index]
[
Thread Index]
- Subject: Re: documentation style - 2nd/3rd person tense for function comments
- From: steve donovan <steve.j.donovan@...>
- Date: 2012年3月27日 08:42:01 +0200
On Tue, Mar 27, 2012 at 3:04 AM, David Manura <dm.lua@math2.org> wrote:
> Should comments for Lua functions be written in the 3rd person
> declarative or 2nd person imperative?
Funny, I've never been aware of the tense of doc comments, perhaps if
we used Latin it would have been more obvious ;)
As with all questions of style: be consistent. Inconsistencies bother
people on a subliminal level.
steve d.