[wp-trac] [WordPress Trac] #56625: Bad link in doc caused by docblock typo

WordPress Trac noreply at wordpress.org
Fri Sep 23 16:19:16 UTC 2022


#56625: Bad link in doc caused by docblock typo
-----------------------------------------------+---------------------------
 Reporter:  Camwynsp                           |       Owner:
                                               |  davidbaumwald
     Type:  defect (bug)                       |      Status:  closed
 Priority:  normal                             |   Milestone:  6.1
Component:  General                            |     Version:  4.6
 Severity:  normal                             |  Resolution:  fixed
 Keywords:  needs-patch good-first-bug commit  |     Focuses:  docs
-----------------------------------------------+---------------------------
Changes (by davidbaumwald):

 * status:  reviewing => closed
 * resolution:   => fixed


Comment:

 In [changeset:"54292" 54292]:
 {{{
 #!CommitTicketReference repository="" revision="54292"
 Docs: Correct `@see` reference to `deprecated_function_run` in the
 `_deprecated_function` docblock.

 In the docblock for `_deprecated_function`, there is a `@see` reference to
 the `deprecated_function_run` hook run inside `_deprecated_function`.
 However, the `@see` reference includes the word "hook" inside the quotes
 which is generating a bad link at
 https://developer.wordpress.org/reference/functions/_deprecated_function/.

 This change simply moves the word "hook" outside the `@see` reference to
 correct the link parsing on https://developer.wordpress.org.

 Props Camwynsp, kebbet, SergeyBiryukov, hilayt24.
 Fixes #56625.
 }}}

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


More information about the wp-trac mailing list