Re: Re: Notes Status, 23323 total
| From: | Sherif Ramadan | Date: | Sun, 15 Dec 2013 17:44:21 +0000 |
| Subject: | Re: Re: Notes Status, 23323 total | ||
| References: | 1 2 | Groups: | php.doc php.notes |
| Request: | Send a blank email to phpdoc+get-969384768@lists.php.net to get a copy of this message | ||
On Sun, Dec 15, 2013 at 11:27 AM, Andrea Faulds <ajf@ajf.me> wrote:
Why do we have this list published here so often? Does it ever change much?
> Is the goal to eliminate as many notes as possible, or something? :P
>
>
What do you mean by so often? This list seems to be fairly new. The first
one I see in the archives was early November and there appear to be a total
of 4 of them since then. So it seems to be either on a weekly or bi-weekly
basis, as far as I can tell. I also find that it serves as a good reminder
that people on the documentation team (all of whom have notes Karma) aren't
moderating the user contributed notes, nearly often enough.
Often it is the case that a page with too many user-contributed notes has a
lot of repeat information or too many examples of the same thing. One of
the objectives behind user notes is to incorporate them into the
documentation if they present something the documentation is currently
lacking. So ultimately, a page that has too many user notes is an
indication that it's not being moderated closely enough. Clearly, we don't
need 18 different examples to show you how to use cookies in curl, for
instance. We also should remove user notes - like this one
http://www.php.net/manual/en/function.curl-setopt.php#93108
- which state
that the documentation is lacking information that it's not. That
particular note is over 4 years old, so I don't know if at some point the
docs were indeed missing that information, that the user claims was
missing, but it no longer is.
There's lots of junk in user notes that could stand to be cleaned up, like
bad information
http://www.php.net/manual/en/function.curl-setopt.php#57988
being
given to users. However, there are also a few *diamonds in the rough*, if
you will, hiding somewhere within that junk - like helpful suggestions
http://php.net/manual/en/function.curl-setopt.php#110457
- that I believe
we should actually incorporate into the documentation. Once incorporated,
or deemed useless/bad, however, we should then remove those notes.