WordPress.org
Get WordPress

Making WordPress.org

Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#4624 closed defect (bug) (fixed)

DevHub: Skip wp-includes/blocks from parsing

Reported by: sergeybiryukov's profile SergeyBiryukov Owned by: coffee2code's profile coffee2code
Milestone: Priority: normal
Component: Developer Hub Keywords: has-patch
Cc:

Description

Background: #4144

​wp-includes/blocks appears to be managed as an external package, and its @since tags are related to the package version, not the WordPress version.

At the moment, ​wp_latest_comments_draft_or_post_title() is incorrectly shown in the reference as introduced in WordPress 3.3.0.

Attachments (1)

4624.patch​ (573 bytes) - added by SergeyBiryukov 5 years ago.

Download all attachments as: .zip

Change History (6)

@SergeyBiryukov
5 years ago

#1 @SergeyBiryukov
5 years ago

  • Keywords has-patch added

#2 @dd32
5 years ago

Functions such as this should probably be marked internal so as not to show up in the index too correct?

@coffee2code any thoughts here?

#3 @coffee2code
5 years ago

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

In 9184:

Developer: Skip parsing of externally maintained files in wp-includes/blocks/*.

Props SergeyBiryukov.
Fixes #4624.

#4 @coffee2code
5 years ago

In this particular case--where entire files are not to be parsed--it is best and sufficient to exclude the files/subdirectories from being parsed as proposed in the patch.

In instances where a particular function or class is intended only for internal use and is not meant to be parsed for public documentation, then the @ignore DocBlock tag should be used.

#5 @coffee2code
5 years ago

Previously parsed functions from the now-excluded files have been removed from the Code Reference.

Note: See TracTickets for help on using tickets.