Re: Real documentation?

From: Date: Mon, 13 Aug 2001 09:50:07 +0000
Subject: Re: Real documentation?
References: 1  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-1425@lists.php.net to get a copy of this message
[Mika Tuupola <tuupola@appelsiini.net>] > On Sun, 12 Aug 2001, Richard Heyes wrote: > > > Where would they sit in cvs though, /doc(s)/package_name/ perhaps? > > Wouldn't it be simplest to just have the docs in the > same directory as the class itself? For example > Net_Foo package would have its docs under Net_Foo/doc/. > > There is no need to spread files all over. Absolutely. If the documentation is moved out of the package's directory, you're kind of saying "documentation is a separate project". All the documentation for a package should be part of the package. After installation it's different though, then it makes more sense to install everything in a separate documentation dir (if not the docs would end up in PHP's include_path). - Stig -- Stig Sæther Bakken <ssb@alltheweb.com> Fast Search & Transfer ASA, Trondheim, Norway

« previous php.pear.dev (#1425) next »