Changeset 5595

Timestamp:

06/21/2017 10:26:50 PM (7 years ago)

Author:

coffee2code

Message:

developer.wordpress.org: Prevent 'Requests' and 'Translations' from being treated as inline class references.

Unlike other class names, 'Requests' and 'Translations' have a decent chance of being used as actual words and not just inline class references, so err on the side of caution. If a class reference is intended for these two class names, the @see notation should be used, e.g. {@see Requests}.

Fixes #2842.

File:

• sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php (modified) (2 diffs)

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php

@@ -377 +377 @@
                     // Most class names start with an uppercase letter and have an underscore.
                     // The exceptions are explicitly listed since future classes likely won't violate previous statement.
+                    // Requests and Translations, due to their higher likelihood of use as a word and not as an inline class
+                    //   reference, should be explicitly referenced, e.g. `{@see Requests}`.
                     '~'
                         . '(?<!/)'
@@ -382 +384 @@
                         . '('                 // Primary match grouping
                             . 'wpdb|wp_atom_server|wp_xmlrpc_server' // Exceptions that start with lowercase letter
-                            . '|AtomFeed|AtomEntry|AtomParser|MagpieRSS|Requests|RSSCache|Translations|Walker' // Exceptions that lack an underscore
+                            . '|AtomFeed|AtomEntry|AtomParser|MagpieRSS|RSSCache|Walker' // Exceptions that lack an underscore
                             . '|_?[A-Z][a-zA-Z]+_\w+'                // Most start with (optional underscore, then) uppercase, has underscore
                         . ')'                 // End primary match grouping