User notes guidelines.
| From: | Levi Morrison | Date: | Wed, 09 Jan 2013 18:05:08 +0000 |
| Subject: | User notes guidelines. | ||
| Groups: | php.webmaster | ||
| Request: | Send a blank email to php-webmaster+get-15273@lists.php.net to get a copy of this message | ||
Firstly, I apologize if this is the incorrect list.
I'm trying to clean up the user notes in certain portions of the
manual. As such, I've reviewed a lot of user contributed notes and
found a few common types of notes that bother me:
1. Code snippets to do something similar to the current function.
2. Reports of performance compared to function X. Incorrect
testing methods are usually involved.
3. Reports an edge-case not included in the manual section.
Some pages of the manual have severe problems with #1. See
http://php.net/manual/en/function.count.php
for an example one such
page. A blanket policy of deleting notes like this would probably be
harmful, but on this page in particular I feel like deleting all
comments of this type.
What really bothers me about #2 is that the testing methods are
usually skewing the results. I don't feel like editing is appropriate
in these situations but am unsure if deletion is appropriate either.
In the case of #3 I feel like we should simply update the manual. The
question then becomes: should we keep the comment?
---
Related: is there a posted guideline for moderating user contributed notes?