WordPress.org

Make WordPress Core

Opened 7 years ago

Closed 7 years ago

#30987 closed defect (bug) (fixed)

get_children() should not be considered internal

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

Description

get_children() is currently marked as @internal in the inline docs (since [8203]).

I think that is why it's missing from the developer reference (originally reported by @gmazzap).

I don't see a reason for that, it has a Codex article and should not be considered internal.

Attachments (1)

30987.diff (726 bytes) - added by DrewAPicture 7 years ago.

Download all attachments as: .zip

Change History (13)

This ticket was mentioned in Slack in #meta-devhub by sergeybiryukov. View the logs.


7 years ago

#2 @DrewAPicture
7 years ago

  • Milestone changed from 4.2 to WordPress.org

This is an issue with the parser, and should be handled on meta trac/GitHub. The perser simply looks for @interal tags of any kind, and the usage here is actually valid. We should really be using @ignore to skip generation of refernece pages.

#3 @DrewAPicture
7 years ago

Opened a pull request on the parser repo, and #meta812.

This ticket was mentioned in Slack in #core by drew. View the logs.


7 years ago

@DrewAPicture
7 years ago

#5 @DrewAPicture
7 years ago

  • Keywords has-patch commit added
  • Milestone changed from WordPress.org to 4.1.1

After talking to @SergeyBiryukov a bit about this, we should simply remove the @internal tag and re-parse the reference for 4.1.1. We can always do an audit later to convert other uses of @internal in core to @ignore as they apply.

30987.diff

#6 @DrewAPicture
7 years ago

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

In 31169:

Remove an erroneous @internal tag from the DocBlock for get_children().

Use of the @internal tag caused the reference article for this function to be skipped during the parsing process.

Fixes #30987 for trunk.

#7 @DrewAPicture
7 years ago

  • Keywords fixed-major added
  • Resolution fixed deleted
  • Status changed from closed to reopened

Reopening for 4.1.1 consideration.

#8 @DrewAPicture
7 years ago

In 31170:

Ensure we're using the correct @ignore phpDocumentor tag to mark elements that should be skipped when parsing.

Up to this point, various core elements' DocBlocks incorrectly included an @internal tag as a means for skipping the parsing process. When paired with a description (inline or otherwise), @internal is a valid tag meant to provide internal-only context, but not necessarily to skip parsing the entire element.

See #30987.

#9 @DrewAPicture
7 years ago

Once the source is re-parsed and the parser changes merged, references will then be generated for (the currently-missing) get_children(), force_balance_tags(), and the_meta().

This ticket was mentioned in Slack in #core by drew. View the logs.


7 years ago

#11 @DrewAPicture
7 years ago

  • Keywords fixed-major removed
  • Milestone changed from 4.1.1 to 4.2

#12 @DrewAPicture
7 years ago

  • Resolution set to fixed
  • Status changed from reopened to closed
Note: See TracTickets for help on using tickets.