>-----Original Message-----
>From: Doug MacEachern
>To: brian moseley
>Cc: modperl-2.0 dev-list
>Sent: 6/25/01 7:04 PM
>Subject: Re: rfc: 2.0 documentation project thoughts
>
>On Sat, 23 Jun 2001, brian moseley wrote:
>
>> would you really trust somebody to write docs that you
>> wouldn't trust to write code? i wouldn't. so i don't think
>> it should be a concern.
>
>i don't know if 'trust' is the right word.  the code/docs split approach
>has been working well for the httpd project.  maybe we don't need todo
>the
>same, we can think about it.

having the docs split is nice, especially for something like mod_perl, where
people may understand the perl API well, but don't necessarily have the
skills to dive into the XS layer and fiddle with it.

[snip]

>> i highly prefer having module doc inline. and i mean inline,
>> interspersed amongst subs, so i can see the doc for a sub
>> when i'm looking at its code. i get annoyed when i have to
>> scroll to the bottom or open a second window to look at the
>> doc for a sub :)
>
>i have the opposite feeling, docs interspersed amongst subs drives me
>crazy.  but if enough people prefer that, i can deal.  

if you're tallying votes now, I concur, inline pod makes my eyes cross -
although *some* inline documentation is always nice ;)

--Geoff

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to