[wp-trac] [WordPress Trac] #27098: Twenty Fourteen: Ditch all uses of `@return void`.

WordPress Trac noreply at wordpress.org
Wed Feb 12 00:35:14 UTC 2014


#27098: Twenty Fourteen: Ditch all uses of `@return void`.
-------------------------------+------------------------------
 Reporter:  philiparthurmoore  |       Owner:
     Type:  defect (bug)       |      Status:  reopened
 Priority:  normal             |   Milestone:  Awaiting Review
Component:  Bundled Theme      |     Version:  trunk
 Severity:  normal             |  Resolution:
 Keywords:                     |     Focuses:  docs
-------------------------------+------------------------------

Comment (by GaryJ):

 Replying to [comment:4 DrewAPicture]:

 > When we developed the standard last fall, the decision was made to
 ignore the use of `@return void` in the bundled themes, as they had been
 utilizing that style since Twenty Ten.

 The decision reference: http://irclogs.wordpress.org/chanlog.php?channel
 =wordpress-sfd&day=2013-09-25&sort=asc#m48668

 > I think there's a good argument in favor of removing them altogether
 from the bundled themes -- this would bring that code in-line with the
 core standard.

 +1.

 > Side note: It's important to remember that while the core inline
 documentation standard is largely based on and inspired by the
 phpDocumenter spec, it doesn't adhere to it 100 percent.

 Also to add, that some of the recent changes are based on the draft PSR-5,
 of which many code editors and phpDocumentor itself doesn't follow fully
 yet.

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


More information about the wp-trac mailing list