httpd-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Rich Bowen <rbo...@rcbowen.com>
Subject Re: <description> and grammar pedantics
Date Wed, 23 Jan 2013 20:40:29 GMT

On Jan 22, 2013, at 7:09 PM, Eric Covener wrote:

> On Mon, Jan 21, 2013 at 10:26 AM, Rich Bowen <rbowen@rcbowen.com> wrote:
>> I noticed this morning that we are very inconsistent with the <description>
>> within a module doc. Some are full sentences. Some start with "This module
>> provides". Some are just a few words like "User-specific directories"
>> 
>> Witness the inconsistency here: http://httpd.apache.org/docs/trunk/mod/
>> 
>> I was thinking of making those more consistent, but thought I'd throw it out
>> on the list here, so that those who are more aware of grammar standards
>> (ahem. Noirin?) could chime in and express an opinion as to the right way to
>> do this.
>> 
> 
> My uneducated preference is mod_asis style which is middle of the road
> for verbosity.
> 
> mod_asis
>  Sends files that contain their own HTTP headers

I should have said - yes, that's my preference too. Repeating "This module" or "This module
provided" each time is annoying and unnecessary.

-- 
Rich Bowen
rbowen@rcbowen.com
Shosholoza



Mime
View raw message