[wp-trac] [WordPress Trac] #28551: Add Better Debugging Documentation Into wp-config.php

[WordPress Trac]

#28551: Add Better Debugging Documentation Into wp-config.php
-------------------------------+-----------------------------
 Reporter:  philiparthurmoore  |       Owner:
     Type:  enhancement        |      Status:  new
 Priority:  normal             |   Milestone:  Future Release
Component:  Bootstrap/Load     |     Version:
 Severity:  normal             |  Resolution:
 Keywords:  needs-patch        |     Focuses:  docs
-------------------------------+-----------------------------

Comment (by F J Kaiser):

 Replying to [comment:21 Rarst]:
 > By the [https://github.com/phpDocumentor/fig-
 standards/blob/master/proposed/phpdoc.md#810-link-deprecated @link is
 deprecated in PSR-5], update to [https://github.com/phpDocumentor/fig-
 standards/blob/master/proposed/phpdoc.md#816-see @see] maybe.

 By now PSR-5 is a draft. But - as usual - we can expect it to go in. +1 on
 that.

 Could we please drop the surrounding brackets? {{{{@link
 https://example.com description}}}} just knocks out automated parsers in
 IDEs and is even against
 [http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.link.pkg.html
 the current standard of phpDocumentor].

 Also I'd drop the explanation of the memory limit. It constantly leads
 people believing that WordPress can do more than their host allows. Or
 just add a line that tells that they should consult their host for the
 max. memory allocated for their box. Something along the lines of

 > To allow WordPress to use the full memory that is allocated for your
 hosting service, please contact your hosting company.

 ''Preferably something more eloquent than above example.''

--
Ticket URL: <https://core.trac.wordpress.org/ticket/28551#comment:22>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform