[wp-trac] [WordPress Trac] #24886: Improve wp-includes/load.php inline documentation

[WordPress Trac]

#24886: Improve wp-includes/load.php inline documentation
-------------------------+------------------------------
 Reporter:  ericlewis    |       Owner:
     Type:  enhancement  |      Status:  new
 Priority:  normal       |   Milestone:  Awaiting Review
Component:  Inline Docs  |     Version:  3.5.2
 Severity:  normal       |  Resolution:
 Keywords:               |
-------------------------+------------------------------

Comment (by ericlewis):

 I also added a bunch of @global tags in here. What did we decide about
 documenting globals? It was spoken about
 [https://irclogs.wordpress.org/chanlog.php?channel=wordpress-
 dev&day=2013-09-04&sort=asc in IRC a few weeks ago], and @nacin suggested
 that @globals are "really easy to abuse," and @uses should be used
 extremely sparingly. I think that constitutes a decision for @uses, we
 should mention it in our PHP Inline Doc standards. However the use of
 @globals is still vague since we didn't make a decision on its suggested
 use.

 Replying to [comment:5 DrewAPicture]:
 > * s/multisite/Multisite

 Should Multisite always be capitalized? Core inline documentation is split
 in this regard. The codex article
 [http://codex.wordpress.org/Create_A_Network Create A Network] goes back
 and forth between capitals and non-caps. Using the term Multisite is
 generally an abbreviation for WordPress Multisite, so I would say let's
 change all our naming conventions here to capitals across the board.

--
Ticket URL: <http://core.trac.wordpress.org/ticket/24886#comment:6>
WordPress Trac <http://core.trac.wordpress.org/>
WordPress blogging software