RE: [PEAR-DEV] RFC: Commentation- and Rating-System für PEAR-Websites
| From: | Lukas Smith | Date: | Thu, 27 Feb 2003 08:47:10 +0000 |
| Subject: | RE: [PEAR-DEV] RFC: Commentation- and Rating-System für PEAR-Websites | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-13970@lists.php.net to get a copy of this message | ||
> From: Martin Jansen [mailto:mj@php.net]
> Sent: Thursday, February 27, 2003 9:22 AM
> On Wed Feb 26, 2003 at 06:1756PM -0500, rocha@i-node.com.br wrote:
> > Citando Martin Jansen <mj@php.net>:
> >
> > > On Wed Feb 26, 2003 at 08:4028PM +0100, Tobias Schlitt wrote:
> > > > The idea is pretty simple. Because of many PEAR packages having
> > > > no online-documentation and to complete the existing examples
> > > > their should be IMHO a possibility to leave some comments on
> > > > each package. I think the best way is to link the comments
> > > > together with the packages themself (respectively the
> > > > corresponding webpage with closer information) and on the other
> > > > hand with the corresponding manual-pages. (Whereupon we have to
> > > > think how manuals with multiple pages should be linked).
> > >
> > > Having such a system will make most developers write absolutely no
> > > documentation for their package, because they expect their users
to
> > > leave some comments instead. I'm -1 on this.
> > Well, that classe will not qualify for PFC either.
>
> I suppose you misunderstand something: A developer, who does not
> contribute to the PFC, is also expected to write documentation.
>
> > And in the long run
> > the comments can help that lazy developer to write some doc with his
> > class.
>
> In 99% of all cases this will not happen. EOD.
Martin we cannot force people to write documentation. Neither by
political nor by technical means. Also this will enable much more than
alternative documentation, like tips and tricks and quality feedback. I
am +1 for a comments addition.
Regards,
Lukas