WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#35019 closed defect (bug) (fixed)

Fix list formatting in the DocBlock description for `get_post_type_labels()`

Reported by: DrewAPicture Owned by: DrewAPicture
Milestone: 4.5 Priority: normal
Severity: normal Version:
Component: Posts, Post Types Keywords: has-patch
Focuses: docs Cc:

Description

The parser supports converting formatted lists in descriptions into unordered lists for the code reference, but indentations within lists are misread as blockquotes.

Attachments (1)

35019.diff (833 bytes) - added by DrewAPicture 5 years ago.

Download all attachments as: .zip

Change History (4)

@DrewAPicture
5 years ago

#1 @DrewAPicture
5 years ago

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

In 35868:

Docs: Remove indentation from a wrapped line in the DocBlock description for get_post_type_labels() to prevent incorrect formatting when parsed.

With the false indentation in place, the parser for the Code Reference incorrectly interprets it as a block quote.

Fixes #35019.

#2 @DrewAPicture
5 years ago

@coffee2code: Could you please add this to your pre-parse checklist for the 4.4.1/4.5 re-parse? I don't think we need to include this in the point release unless wp-includes/posts.php is touched for another reason.

The formatting has been fixed temporarily in the code reference article, and this ticket has been attached.

#3 @coffee2code
5 years ago

@DrewAPicture: I've made a note to accommodate this before any 4.4.x/4.5 parsing.

Note: See TracTickets for help on using tickets.