[wp-trac] [WordPress Trac] #29111: In /wp-admin/user, not all files are documented consistently

WordPress Trac noreply at wordpress.org
Mon Aug 4 22:20:17 UTC 2014


#29111: In /wp-admin/user, not all files are documented consistently
--------------------------+-----------------------------
 Reporter:  NikV          |      Owner:
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  General       |    Version:  trunk
 Severity:  normal        |   Keywords:
  Focuses:  docs          |
--------------------------+-----------------------------
 In /wp-admin/user, the first few files (about.php, credits.php,
 freedoms.php, index.php) have a simple code snippet at the beginning of
 the file as shown below.
 {{{
 /** Load WordPress Administration Bootstrap */
 require_once( dirname( __FILE__ ) . '/admin.php' );
 }}}

 But in that same folder, there are a few files that do not have the same
 documentation (above the require_once) as the rest. I think to keep up
 with consistency of inline documentation, the rest of the files (in that
 folder) should be documented the same way if they have the same code
 snippet. I have attached the files that did not have the inline docs, but
 now do.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/29111>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list