WordPress.org
Get WordPress

Make WordPress Core

Opened 10 years ago

Closed 10 years ago

Last modified 10 years ago

#36333 closed defect (bug) (fixed)

Update docblock for validate_plugin

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

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 10 years ago.
Patch for validate_plugin() docblock

Download all attachments as: .zip

Change History (6)

@theMikeD
10 years ago

Patch for validate_plugin() docblock

#1 @theMikeD
10 years ago

  • Focuses docs added
  • Type defect (bug) → enhancement
  • Version → trunk

#2 @DrewAPicture
10 years ago

  • Keywords has-patch added
  • Milestone Awaiting Review → Future Release
  • Owner set to DrewAPicture
  • Status new → reviewing
  • Type enhancement → defect (bug)
  • Version trunk → 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
10 years ago

  • Component Text Changes → Plugins
  • Milestone Future Release → 4.8

#4 @SergeyBiryukov
10 years ago

  • Resolution → fixed
  • Status reviewing → closed

In 39889:

Docs: Improve the DocBlock for validate_plugin().

Props theMikeD.
Fixes #36333.

#5 @SergeyBiryukov
10 years 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.