[wp-trac] [WordPress Trac] #47771: Replace Codex links with their HelpHub counterparts

WordPress Trac noreply at wordpress.org
Mon Jul 29 14:12:47 UTC 2019


#47771: Replace Codex links with their HelpHub counterparts
--------------------------------------+-----------------------------
 Reporter:  SergeyBiryukov            |       Owner:  SergeyBiryukov
     Type:  enhancement               |      Status:  reviewing
 Priority:  normal                    |   Milestone:  5.3
Component:  General                   |     Version:
 Severity:  normal                    |  Resolution:
 Keywords:  good-first-bug has-patch  |     Focuses:  docs
--------------------------------------+-----------------------------
Changes (by ianbelanger):

 * keywords:  good-first-bug has-patch needs-testing => good-first-bug has-
     patch


Comment:

 Replying to [comment:10 ramiy]:
 > Replying to [comment:9 ianbelanger]:
 >
 >
 > We do have a URL for:
 > https://codex.wordpress.org/Function_Reference/is_main_query
 > located in:
 > https://developer.wordpress.org/reference/functions/is_main_query/
 >
 > Also, we can replace:
 > https://codex.wordpress.org/Function_Reference/wpdb_Class
 > With:
 > https://developer.wordpress.org/reference/classes/wpdb/
 >
 > and:
 > https://codex.wordpress.org/Class_Reference/WP_Object_Cache
 > with:
 > https://developer.wordpress.org/reference/classes/wp_object_cache/

 Thanks @ramiy,

 It appears that
 https://codex.wordpress.org/Class_Reference/WP_Object_Cache and
 https://codex.wordpress.org/Function_Reference/wpdb_Class are each used in
 1 place in Core, within the docblocks of their respective classes. Since
 the Codex contains much more information describing what the classes are,
 and not just the class code itself, like in DevHub. I think that we should
 leave these 2 links alone in Core until there is either a HelpHub or more
 descriptive DevHub page.

 Also, https://codex.wordpress.org/Function_Reference/is_main_query is used
 in only one place in Core in `query.php` It is referenced in a
 notification message describing how to use `is_main_query` when filtering
 `pre_get_posts`. It is referencing something that is specifically
 described in Codex, but is not described in DevHub. So IMO we should
 probably leave this link alone as well.

 If anyone disagrees, please feel free to state your case.

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


More information about the wp-trac mailing list