Re: [PATCH] CodingGuidelines: Add a section on writing documentation
From: Sverre Rabbelier <hidden>
Date: 2016-06-15 22:49:56
Heya, On Fri, Oct 29, 2010 at 04:54, Štěpán Němec [off-list ref] wrote:
But given that it's only used as {0,2} at the two places right now
(disregarding occurences of "0{40}" in the documentation), I agree it
might be better to get rid of it, although I don't feel strongly about
it. Any other opinions?Let's get rid of it for now, we can always resurrect it later if we have a need for it.
I thought about this already when preparing the recent unification series, and came to the conclusion "no, there shouldn't". :-) As the examples you give show, the current usage is inconsistent, but given that it brings no semantic ambiguity, I don't think it is a problem. You could find more similar cosmetic inconsistencies and I don't think it makes much sense to mandate any rules for such things. (But again, I don't feel _too_ strongly about this either, so if more people think it's worth it, I can prepare a patch that unifies them and mention the preference in CodingGuidelines.)
Perhaps we can set a standard to do it, but just leave the existing cases as is (to prevent unneeded churn)? That way we'll eventually converge on something. -- Cheers, Sverre Rabbelier