Mailing List Archive


[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [tlug] linux@example.com How many widely can we do that?



Stephen J. Turnbull wrote:
> Edward Middleton writes:
>
>  > Stephen, I take it your argument against inline documentation
>
> First off, my original argument was against documentation *generated
> from* code, not documentation *mixed with* code.
>   

OK, the standard ruby documentation method rdoc uses both, but allows
you to exclude internal classes, modules, methods and functions.

>  > There is also the added advantage that inconsistencies between spec
>  > and actual behavior become more obvious.
>
> That depends on whether the users agree that the inline documentation
> is the spec.  See my response to Curt regarding choice of version.
>   

It sounds like your issue is more with belligerent developers rather
then inline specs.

Edward


Home | Main Index | Thread Index

Home Page Mailing List Linux and Japan TLUG Members Links