WordPress.org

Make WordPress Core

Opened 19 months ago

Closed 9 months ago

Last modified 9 months ago

#36333 closed defect (bug) (fixed)

Update docblock for validate_plugin

Reported by: theMikeD Owned by: DrewAPicture
Milestone: 4.8 Priority: normal
Severity: normal Version: 2.7.1
Component: Plugins Keywords: has-patch
Focuses: docs Cc:

Description

Make the docblock consistant with other sections that use the same info, and to increase clarity now that devhub pulls directly from it.

Attachments (1)

36333.diff (632 bytes) - added by theMikeD 19 months ago.
Patch for validate_plugin() docblock

Download all attachments as: .zip

Change History (6)

@theMikeD
19 months ago

Patch for validate_plugin() docblock

#1 @theMikeD
19 months ago

  • Focuses docs added
  • Type changed from defect (bug) to enhancement
  • Version set to trunk

#2 @DrewAPicture
19 months ago

  • Keywords has-patch added
  • Milestone changed from Awaiting Review to Future Release
  • Owner set to DrewAPicture
  • Status changed from new to reviewing
  • Type changed from enhancement to defect (bug)
  • Version changed from trunk to 2.7.1

Hi @theMikeD, thanks for the patch!

Per the inline documentation standards, DocBlock summaries and parameter descriptions should both end with periods. Otherwise, much better, thanks :-)

We'll get this in first thing in 4.6.

#3 @SergeyBiryukov
9 months ago

  • Component changed from Text Changes to Plugins
  • Milestone changed from Future Release to 4.8

#4 @SergeyBiryukov
9 months ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 39889:

Docs: Improve the DocBlock for validate_plugin().

Props theMikeD.
Fixes #36333.

#5 @SergeyBiryukov
9 months ago

In 39890:

Docs: Use a consistent description for $plugin parameter in various plugin API functions.

See #36333.

Note: See TracTickets for help on using tickets.