[wp-trac] [WordPress Trac] #48109: PHPDoc correction for edit_bookmark_link in wp-includes/link-template.php

[WordPress Trac]

#48109: PHPDoc correction for edit_bookmark_link in wp-includes/link-template.php
--------------------------+-----------------------------
 Reporter:  atachibana    |       Owner:  SergeyBiryukov
     Type:  defect (bug)  |      Status:  reviewing
 Priority:  normal        |   Milestone:  5.3
Component:  General       |     Version:
 Severity:  minor         |  Resolution:
 Keywords:  has-patch     |     Focuses:  docs
--------------------------+-----------------------------
Description changed by SergeyBiryukov:

Old description:

> Enhanced missing information of Codex for edit_bookmark_link() in wp-
> includes/link-template.php.
> When $link is '', default value 'Edit This' is set in the function body.
>
> {{{
> - * @param string $link     Optional. Anchor text. Default empty.
> + * @param string $link     Optional. Anchor text. If empty, default is
> 'Edit This'. Default empty.
> }}}
>
> Codex: https://codex.wordpress.org/Function_Reference/edit_bookmark_link
> Code Reference:
> https://developer.wordpress.org/reference/functions/edit_bookmark_link/
>
> Above description was taken from edit_comment_link() in the same
> function.
>
> This is the action of inline docs and Codex migration initiatives.

New description:

 Enhanced missing information of Codex for edit_bookmark_link() in wp-
 includes/link-template.php.
 When $link is `''`, default value `'Edit This'` is set in the function
 body.

 {{{
 - * @param string $link     Optional. Anchor text. Default empty.
 + * @param string $link     Optional. Anchor text. If empty, default is
 'Edit This'. Default empty.
 }}}

 Codex: https://codex.wordpress.org/Function_Reference/edit_bookmark_link
 Code Reference:
 https://developer.wordpress.org/reference/functions/edit_bookmark_link/

 Above description was taken from edit_comment_link() in the same function.

 This is the action of inline docs and Codex migration initiatives.

--

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