WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

#30509 closed defect (bug) (fixed)

PHPDoc correction for wp_generate_password() in wp-includes/pluggable.php

Reported by: stevegrunwell Owned by: DrewAPicture
Milestone: 4.1 Priority: normal
Severity: normal Version:
Component: General Keywords: has-patch commit
Focuses: docs Cc:

Description

Used wp_generate_password() as an example of DocBlocks on some internal 10up documentation, @DrewAPicture was quick to point out that the formatting was wrong (missing periods, improper closing comment (two asterisks instead of one)).

Attachments (2)

30509.diff (904 bytes) - added by stevegrunwell 6 years ago.
Adds missing periods, fixes improper closing of DocBlock
30509.patch (904 bytes) - added by stevegrunwell 6 years ago.
Or, you know, the patch could be named properly.

Download all attachments as: .zip

Change History (6)

@stevegrunwell
6 years ago

Adds missing periods, fixes improper closing of DocBlock

#1 @stevegrunwell
6 years ago

  • Keywords has-patch added

@stevegrunwell
6 years ago

Or, you know, the patch could be named properly.

#2 @DrewAPicture
6 years ago

  • Keywords commit added
  • Milestone changed from Awaiting Review to 4.1

Hi Steve, thanks for the patch. Also the wrapped description text should align with the first character of the description it goes with. I'll fix it on commit.

#3 @DrewAPicture
6 years ago

Actually, also the optional arguments aren't marked as such and the defaults also aren't specified ... FYI :-)

#4 @DrewAPicture
6 years ago

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

In 30580:

Fix DocBlock formatting for wp_generate_password().

Props stevegrunwell for the initial patch.
Fixes #30509.

Note: See TracTickets for help on using tickets.