user contributed notes

php.internals

Harrie Hazewinkel

23 years ago
Hi, 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?? regards, Harrie

Derick Rethans

23 years ago
On Mon, 14 Jul 2003, Harrie Hazewinkel 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??
Questions can be removed, but tips and other notes should stay there. Derick
-- "Interpreting what the GPL actually means is a job best left to those that read the future by examining animal entrails." ------------------------------------------------------------------------- Derick Rethans http://derickrethans.nl/ International PHP Magazine http://php-mag.net/ -------------------------------------------------------------------------

Chris Shiflett

23 years ago
--- 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