[wp-trac] [WordPress Trac] #44424: PHPDoc comments and @return tags missing at many places

WordPress Trac noreply at wordpress.org
Tue Jan 15 06:09:31 UTC 2019


#44424: PHPDoc comments and @return tags missing at many places
-------------------------------------+-------------------------------------
 Reporter:  subrataemfluence         |       Owner:  (none)
     Type:  defect (bug)             |      Status:  new
 Priority:  normal                   |   Milestone:  5.1
Component:  I18N                     |     Version:  trunk
 Severity:  normal                   |  Resolution:
 Keywords:  has-patch needs-refresh  |     Focuses:  docs, coding-standards
-------------------------------------+-------------------------------------
Changes (by pento):

 * keywords:  has-patch => has-patch needs-refresh


Comment:

 Reviewing [attachment:"44424.diff"]:

 - `$entries` and `$headers` could do with descriptions.
 - `get_header()` returns a header, not an element.
 - `translate_entry()` returns an entry, not an element.
 - `select_plural_form()` returns `int`, and the return needs a
 description.
 - `translate_plural()` only returns a `string`. The params and return need
 a description.
 - `gettext_select_plural_form()` returns the result of calling the
 callable that `make_plural_form_function()` returns. The callable that
 `make_plural_form_function()` returns will return an `int`.
 - `make_plural_form_function()` returns a `callable`.
 - All of the docblocks added to `NOOP_Translations` need descriptions.

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


More information about the wp-trac mailing list