Re: Notes Status, 23372 total
| From: | Maciek Sokolewicz | Date: | Sun, 29 Dec 2013 14:27:06 +0000 |
| Subject: | Re: Notes Status, 23372 total | ||
| References: | 1 2 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969384782@lists.php.net to get a copy of this message | ||
On 29-12-2013 13:28, Leam Hall wrote:
On 12/28/2013 11:30 PM, phpdoc@lists.php.net wrote:Exactly what you said. The high amount of comments on a page usually indicates that some form of expected documentation is missing or unclear. That's why people add comments and attempt to help others who have the same question, looking at that page. By having a look through the comments, you can find what information is apparently often wanted, add that to the documentation, and then remove those comments. Thereby "polishing" the documentation page. - Tul P.S. comments that do not apply should always be removed.Following are the top 20 pages of the manual, sorted by the number of user notes contributed. These sections could use a polish, those notes represent 6.5% of the 23372 total user notes.Newbie question here. What does "could use a polish" mean, really? Edit the page to include the user comments? Polish the comments? Remove comments that do not apply? Leam