Re: Publishing API documentation for each release
| From: | Martin Jansen | Date: | Tue, 09 Mar 2004 07:14:46 +0000 |
| Subject: | Re: Publishing API documentation for each release | ||
| References: | 1 2 3 4 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-2931@lists.php.net to get a copy of this message | ||
On Tue Mar 09, 2004 at 12:4825AM +0100, David Costa wrote:
> I found some packages with an excellent documentation (including
> examples) on the author/s web site (properly linked on the pear package
> info page)
> but with no documentation on the pear manual.
>
> Is this normal or ?
Definitively not. In such cases we should
a) add a short passage about this package, which essentially say
"Package Foo_XYZ does this and that. More information can be found
on the <ulink url="http://example.com/bar/">authors
homepage</ulink>"
b) (even better) contact the authors and ask them, if we are allowed to
merge their documentation into the manual. This however requires,
that they are willing to abandon the documentation on their site and
maintain it in the manual instead. Otherwise we'd soon have two
different versions of the same documentation, which is no good.
--
- Martin Martin Jansen
http://martinjansen.com/