[wp-trac] [WordPress Trac] #26874: timer_stop() returns a string, not a float

[WordPress Trac]

#26874: timer_stop() returns a string, not a float
----------------------------------------+------------------------------
 Reporter:  GregLone                    |       Owner:
     Type:  defect (bug)                |      Status:  new
 Priority:  normal                      |   Milestone:  Awaiting Review
Component:  Inline Docs                 |     Version:  trunk
 Severity:  minor                       |  Resolution:
 Keywords:  needs-patch good-first-bug  |
----------------------------------------+------------------------------

Comment (by DrewAPicture):

 Replying to [comment:2 nacin]:
 > On the other hand, since this is particular to inline docs (more in a
 moment), then it could of course benefit from a lower barrier to entry.
 >
 > Back to the alternative reality: It would be prudent to ask if it should
 return a float or a string. In this case, it is clear that a string is
 desired due to the use of number_format(_i18n). Thus changing the docs do
 appear to be in order. This would benefit from an explanation in @return
 that the number is formatted for human consumption (versus profiling) — it
 is both localized and rounded.

 Yes, exactly. I'm fairly certain you don't want to get into the further
 fragmentation of good-first-docs-bug and on we go down the rabbit hole.

 I think if a ticket is the Inline Docs component and marked good-first-bug
 that should prove to be more than enough of a hint of the type of effort,
 thought, and patch required :)

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