Re: Notes Status, 24899 total
"Larry Garfield" <[email protected]>
| Newsgroups | gmane.comp.php.documentation.general |
|---|---|
| Message-ID | <[email protected]> |
On Mon, Aug 17, 2020, at 11:00 AM, Christoph M. Becker wrote: > On 17.08.2020 at 17:05, Larry Garfield wrote: > > > On Sat, Aug 15, 2020, at 3:10 PM, Derick Rethans wrote: > > > >> On 15 August 2020 21:02:28 BST, Larry Garfield <[email protected]> wrote: > >> > >>> I'm flexible on what that is; I just want to avoid deleting things too > >>> aggressively and getting yelled at. > >> > >> I used to be quite aggressive deleting the ones in the DateTime pages. > >> Everything that was code, a "this is how to use it", I would delete. > >> The idea behind notes is to improve the documentation. So notes either > >> need to be incorporated or deleted. > > > > So it sounds like the consensus is "improving the doc page so that comments are redundant, and then purging redundant or off-topic comments with extreme prejudice" is an OK thing to do, and should be encouraged, even if we've been slacking on it badly. Yes? > > More or less; I don't mind keeping a feew user nots which may not be > relevant enough for the manual proper, but might still be helpful. See > also <http://doc.php.net/tutorial/user-notes.php>. > > -- > Christoph M. Becker Right then. I went through and cleaned up 4 of the top-10 pages, resulting in these PRs: https://github.com/php/doc-en/pull/134 https://github.com/php/doc-en/pull/135 https://github.com/php/doc-en/pull/136 https://github.com/php/doc-en/pull/137 It didn't clean out all of the comments by far, but I think it at least knocked those 4 out of the top 10 list. --Larry Garfield