[wp-trac] [WordPress Trac] #45643: PHPDoc errors in functions.php

WordPress Trac noreply at wordpress.org
Thu Mar 28 21:40:31 UTC 2019


#45643: PHPDoc errors in functions.php
-------------------------------------+-----------------------------
 Reporter:  subrataemfluence         |       Owner:  SergeyBiryukov
     Type:  defect (bug)             |      Status:  reviewing
 Priority:  normal                   |   Milestone:  5.2
Component:  General                  |     Version:  5.0.1
 Severity:  normal                   |  Resolution:
 Keywords:  has-patch needs-refresh  |     Focuses:  docs
-------------------------------------+-----------------------------

Comment (by johnbillion):

 Replying to [comment:3 subrataemfluence]:
 > In this case, I think it might be more logical to mention how it
 actually gets the arguments. To me it looks a bit misleading to have them
 here without mentioning the actual source. May be not super important, but
 might be given a thought! :)

 The function's usage is documented in the docblock summary, but granted
 it's not clear how its parameters are populated just by looking at the
 docs. Suggestions for improvements to the summary or its parameter docs
 welcome.

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


More information about the wp-trac mailing list