[wp-trac] [WordPress Trac] #55154: Typo in a comment in wp_get_image_mime()

WordPress Trac noreply at wordpress.org
Sat Feb 12 22:54:45 UTC 2022

#55154: Typo in a comment in wp_get_image_mime()
 Reporter:  SergeyBiryukov            |       Owner:  SergeyBiryukov
     Type:  defect (bug)              |      Status:  closed
 Priority:  normal                    |   Milestone:  6.0
Component:  Media                     |     Version:
 Severity:  trivial                   |  Resolution:  fixed
 Keywords:  good-first-bug has-patch  |     Focuses:  docs

Comment (by SergeyBiryukov):

 Replying to [comment:3 azouamauriac]:
 > Hi I think the first word in the comment should be "uses" as it referred
 to the third person of singular what replace "the block".

 Thanks for the note! That recommendation from the documentation standards
 refers to function DocBlocks, however this is just an inline comment and
 not a DocBlock, so it looks fine to me as is. It describes the next few
 lines of the code, and not what the function does in general. The function
 DocBlock does use a third-person singular verb:
 > `Returns the real mime type of an image file.`

Ticket URL: <https://core.trac.wordpress.org/ticket/55154#comment:4>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform

More information about the wp-trac mailing list