[wp-trac] [WordPress Trac] #59992: Document global $locale in wp-admin/options.php (was: Docs: Improve various globals documentation, as per docblock standards.)

[WordPress Trac]

#59992: Document global $locale in wp-admin/options.php
--------------------------+-------------------------------------
 Reporter:  upadalavipul  |       Owner:  (none)
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  General       |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  2nd-opinion   |     Focuses:  docs, coding-standards
--------------------------+-------------------------------------
Changes (by sabernhardt):

 * keywords:   => 2nd-opinion
 * focuses:  coding-standards => docs, coding-standards


Comment:

 The `$locale` global is on
 [https://core.trac.wordpress.org/browser/trunk/src/wp-
 admin/options.php?rev=56949#L347 line 347], not inside a named function
 with its own docblock.  59992.patch adds to the docblock for the
 `allowed_options` filter, which does not include the global variable. The
 comment immediately above line 347 could be good enough.

 [39122] added the `$locale` variable (and the comment).

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