[wp-meta] [Making WordPress.org] #3165: Expose top-level @see tag contents in code reference pages

Making WordPress.org noreply at wordpress.org
Tue Sep 26 15:22:54 UTC 2017

#3165: Expose top-level @see tag contents in code reference pages
 Reporter:  DrewAPicture   |      Owner:
     Type:  enhancement    |     Status:  new
 Priority:  normal         |  Milestone:
Component:  Developer Hub  |   Keywords:  needs-patch
 Recently received a contributor note on the reference for
 `wp_remote_request()` asking about which arguments are accepted, and I
 realized that we explicitly point to `WP_Http::request()` for additional
 information on default arguments, except that information isn't exposed
 anywhere in the wporg-developer theme.

 I'm thinking maybe we should just expose the contents of the top-level
 `@see` tags at the end of the description, rather than as part of the
 explanation (since it's parsed). Either way, this is one very good example
 of where useful information in the docblock isn't getting translated into
 the Code Reference for the wider audience.

Ticket URL: <https://meta.trac.wordpress.org/ticket/3165>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org

More information about the wp-meta mailing list