WordPress.org

Make WordPress Core

#50473 closed defect (bug) (fixed)

Change all "html" and "xhtml" instances within inline docs to "HTML" and "XHTML"

Reported by: desrosj Owned by: SergeyBiryukov
Milestone: 5.5 Priority: normal
Severity: normal Version:
Component: General Keywords: good-first-bug has-patch
Focuses: docs Cc:

Description

HTML and XHTML are acronyms and should be capitalized within inline documentation.

Function names, parameters, and option keys should be exempt and remain the same.

Sources (which use all caps throughout):
HTML5 specification: https://www.w3.org/TR/2017/REC-html52-20171214/
XHTML specification: https://www.w3.org/TR/xhtml1/

Attachments (1)

50473.patch (27.5 KB) - added by navidos 10 months ago.

Download all attachments as: .zip

Change History (5)

#1 @desrosj
10 months ago

  • Keywords needs-patch added

Related: #50064.

@navidos
10 months ago

#2 @navidos
10 months ago

  • Keywords has-patch added; needs-patch removed

Initial patch uploaded

#3 @SergeyBiryukov
10 months ago

  • Milestone changed from Awaiting Review to 5.5

Thanks for the patch!

Just noting that class-snoopy.php and SimplePie are external libraries and should be left out of the changes here.

Looks good otherwise.

#4 @SergeyBiryukov
10 months ago

  • Owner set to SergeyBiryukov
  • Resolution set to fixed
  • Status changed from new to closed

In 48199:

Docs: Replace "html" and "xhtml" instances in DocBlocks and comments with "HTML" and "XHTML".

This ensures consistent capitalization where appropriate.

Props navidos, desrosj.
Fixes #50473.

Note: See TracTickets for help on using tickets.