What documentation style should we use?

Matthew Woehlke mw_triad at users.sourceforge.net
Fri May 18 22:00:57 UTC 2007


Andreas Pakulat wrote:
> On 18.05.07 16:05:11, Matthew Woehlke wrote:
>> While working on the VCS Interfaces I've noticed a couple different 
>> styles for documentation, specifically some sentences end with periods, 
>> some don't, some things have initial capitals, some don't. Is there a 
>> set of rules we should be following for this? I would have thought 
>> "English sentences", meaning always capitalize and always end with a 
>> period...?
> 
> fine with me. If comments from me are lacking either please fix or tell
> me. Especially I tend to forget the period at the end of sentences. Its
> nothing that I meant to do that wasy, I just forget it :)

No worries, no rush... at some point I expect to basically do a 
proofreading pass over the VCS-Iface docs. I can clean things up then, I 
just want to make sure I'm cleaning up the right way.

-- 
Matthew
Excessive obscurity: -5





More information about the KDevelop-devel mailing list