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

Making WordPress.org noreply at wordpress.org
Thu Sep 28 21:46:41 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  |  Resolution:
 Keywords:  needs-patch    |
---------------------------+------------------

Comment (by mnelson4):

 > 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).

 Yeah I think that would be a great start; it would be ideal if whatever
 was after `@see` was actually a link to the relevant docs page.

 e.g., a PHPDoc of `@see WP_Http::request() For additional information on
 default arguments.` would become the HTML `See <a
 href="https://developer.wordpress.org/reference/classes/wp_http/request/">WP_HTTP::request()</a>
 For additional information on default arguments.` on
 developer.wordpress.org.

 But I suspect making that a link might be tricky.

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


More information about the wp-meta mailing list