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

 First: +1 - I'm 100% in on that.

 Replying to [comment:3 georgestephanis]:
 > (...) base a decent amount of our implementation off how PHP handles
 their config file's inline documentation.

 About the coding standard, I have to agree with [comment:7 rmccue]:
 > (...) using hash comments (`#`) for lines of code that can be
 commented/uncommented, as it makes it clear what's a comment and what's a
 disabled line of code.

 That's what I use myself for the sole reason of making different comments
 distinguishable.

 One suggestion I have is to shorten the intro docBlock and split up.
 Something like this:

 {{{
 // NOTE: Remove the # on the start of a line to activate it

 /**
  * Turns on debugging mode.
  * Default: false.
  */
 # define( 'WP_DEBUG', true );
 }}}

 People really hate reading. Instead they try and fail and forget what they
 have tried and panic. So I would stick one very brief docBlock to each
 single constants.

 -----

 As I like the idea of maturing the {{{wp-config.php}}} to something like
 the {{{php.ini}}}, here's for a more complete example the {{{wp-
 config.php}}} for my {{{nightly.dev}}} trac setup. I use similar config
 files for all my installs (but this messy one was the one I had at hand):
 https://gist.github.com/franz-josef-kaiser/f09a93d8fc6e1254f034

 Imo we could add an even more complete config file to the core package as
 a lot of possiblities aren't even known to seasoned devs. Maybe split up
 with a '''"below it's your fault"''' comment/separator.

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