[wp-trac] [WordPress Trac] #37319: Documentation for first parameter of `comment_max_links_url` is incorrect

[WordPress Trac]

#37319: Documentation for first parameter of `comment_max_links_url` is incorrect
-------------------------------------------------+-------------------------
 Reporter:  ocean90                              |       Owner:
     Type:  defect (bug)                         |      Status:  new
 Priority:  normal                               |   Milestone:  Future
Component:  Comments                             |  Release
 Severity:  normal                               |     Version:  3.8
 Keywords:  good-first-bug has-patch needs-      |  Resolution:
  refresh                                        |     Focuses:  docs
-------------------------------------------------+-------------------------
Changes (by rachelbaker):

 * keywords:  good-first-bug has-patch => good-first-bug has-patch needs-
     refresh


Comment:

 @pbearne Thanks for the patch.  While I agree that `comment_max_links_url`
 isn't the BEST filter name, I don't see why the scope of this ticket can't
 be kept to just updating the parameter description.

 Additional feedback on [attachment:comment.php.13.patch] :

 1. Core already has `pre_option_{name}` filters (example:
 `pre_option_comment_max_links`) which should suffice most use-cases of the
 `comment_max_links_allowed` filter you added.
 2. Your patch should only include code changes, not additional style or
 formatting refactoring.  See:
 https://make.wordpress.org/core/handbook/contribute/code-refactoring/

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