[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 Rarst):

 Replying to [comment:5 siobhan]:
 > I've taken a pass at this here:
 https://gist.github.com/smckeown/74cce2d31297646fe8f7
 >
 > I'd appreciate technical feedback and also any feedback re:documentation
 standards.

 As other suggested the constant definition should immediately follow their
 description and be easy t comment/uncomment. That is pretty established in
 config files which allow comments. Values in commented code/examples
 should be same as defaults, not opposite so simply uncommenting doesn't
 change behavior.

 "Turn on/off" wording is clunky. It's unclear if it refers to
 commenting/uncommenting or setting to true/false. For example "Turn on for
 production sites" for WP_DEBUG_DISPLAY, while you actually want it to be
 false.

 > Just a few points:
 >
 > - I've left the uncommented constants as Philip put them in, but should
 they be set to the defaults?

 I think anything but WP_DEBUG (which is set in current config) should be
 set to defaults and commented. Since core handles defaults for all of
 these, there is no reason to overload user with handling them.

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