WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

#34863 closed defect (bug) (fixed)

Document $text parameter in capital_P_dangit()

Reported by: swissspidy Owned by: timplunkett
Milestone: 4.5 Priority: normal
Severity: minor Version:
Component: General Keywords: good-first-bug has-patch commit
Focuses: Cc:

Description

capital_P_dangit() takes a $text parameter that is used to replace Wordpress with WordPress in. That parameter is not documented at all.

I know it's a minor bug, but fixing this doesn't hurt.

See the PHP documentation standards for more details.

Attachments (2)

34863.diff (427 bytes) - added by timplunkett 6 years ago.
34863-3.diff (465 bytes) - added by timplunkett 6 years ago.

Download all attachments as: .zip

Change History (7)

@timplunkett
6 years ago

#1 @timplunkett
6 years ago

  • Keywords has-patch added; needs-patch removed

The docs standards I could find don't specify if @staticvar goes above or below @param, but other functions mostly have @staticvar first, so I mimicked that.

#2 @swissspidy
6 years ago

  • Owner set to timplunkett
  • Status changed from new to assigned

@timplunkett Thanks for the patch! That was quick :)

Yeah, @staticvar comes first. I just realized that a @return tag is missing as well. Would you mind adding that too?

@timplunkett
6 years ago

#3 @timplunkett
6 years ago

Sure thing :)

#4 @swissspidy
6 years ago

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

#5 @swissspidy
6 years ago

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

In 35803:

Docs: Add proper @param and @return tags for capital_P_dangit().

Props timplunkett.
Fixes #34863.

Note: See TracTickets for help on using tickets.