[wp-trac] [WordPress Trac] #43254: Link to the Conditional Tags article in the themes handbook from DocBlocks for all conditional tag functions

[WordPress Trac]

#43254: Link to the Conditional Tags article in the themes handbook from DocBlocks
for all conditional tag functions
--------------------------------------+-----------------------
 Reporter:  DrewAPicture              |       Owner:  janalwin
     Type:  task (blessed)            |      Status:  assigned
 Priority:  normal                    |   Milestone:  5.0
Component:  Themes                    |     Version:
 Severity:  normal                    |  Resolution:
 Keywords:  good-first-bug has-patch  |     Focuses:  docs
--------------------------------------+-----------------------

Comment (by DrewAPicture):

 Hi @janalwin, thanks for the patch.

 I think there may have been a disconnect in how you understood the task
 description. Your patch uses standalone `@link` tags, which aren't exposed
 in the Code Reference. The main reason for using an inline `@link` tag is
 so that we can expose in the function descriptions on the Code Reference
 for each of these functions.

 In short, your patch proposes something like this:
 {{{
 #!diff
 ===================================================================
 --- file.php
 +++ file.php
 @@ -463,7 +463,9 @@
 - *
 + *
 + * @link https://developer.wordpress.org/themes/basics/conditional-tags/
 + *
 }}}

 When I was expecting something more like this:
 {{{
 #!diff
 ===================================================================
 --- file.php
 +++ file.php
 @@ -463,7 +463,9 @@
 - *
 + * For more information on this and similar theme functions, check out
 the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
 Conditional Tags}
 + * article in the Theme Developer Handbook.
 + *
 }}}

 Would you like to update your patch to use inline `@link` tags instead?

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