Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:3415
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Message-ID: <20030714201601.34032.qmail@web14304.mail.yahoo.com>
Date: Mon, 14 Jul 2003 13:16:01 -0700 (PDT)
Reply-To: shiflett@php.net
To: Harrie Hazewinkel <harrie@php.net>, internals@lists.php.net
In-Reply-To: <E44B1020-B636-11D7-8CB2-0003934A5A7E@php.net>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Subject: Re: [PHP-DEV] user contributed notes
From: shiflett@php.net (Chris Shiflett)
References: <E44B1020-B636-11D7-8CB2-0003934A5A7E@php.net>

--- Harrie Hazewinkel <harrie@php.net> wrote:
> Could someone explain what the purpose is of 'User Contributed Notes".
> I noticed some notes as part of snmpget.php which are not notes,
> but questions for help.
> http://www.php.net/manual/en/function.snmpget.php
> 
> Not sure what to do with them, and if I can delete the questions??

The notes are just a place where people can enhance the documentation with
their own real-world experiences and help to fill in any gaps. You are right
that they are not the place for users to ask questions.

I would hesitate to remove questions in cases where they have already been
answered and might be helpful to someone, but that's just me. I'm sure you're
fine to just use your best judgment.

In cases where the user notes fill in gaps left by the documentation or are
otherwise useful, it would be nice to integrate that information into the
documentation itself, perhaps enhancing and/or correcting it in the process.

Chris