WordPress.org

Make WordPress Core

Opened 7 years ago

Closed 7 years ago

#28690 closed defect (bug) (fixed)

load_plugin_texdomain() PHPDoc doesn't document return value.

Reported by: jdgrimes Owned by: SergeyBiryukov
Milestone: 4.0 Priority: normal
Severity: normal Version: 2.8
Component: I18N Keywords:
Focuses: docs Cc:

Description

Since 2.8 (#10286), load_plugin_textdomain() has had a boolean return value, but it doesn't have the @return tag documenting this in its docblock. (Prior to 2.8, it did not return a value.)

Attachments (2)

28690.diff (887 bytes) - added by jdgrimes 7 years ago.
28690.2.diff (1.3 KB) - added by DrewAPicture 7 years ago.

Download all attachments as: .zip

Change History (10)

@jdgrimes
7 years ago

#1 @jdgrimes
7 years ago

  • Keywords has-patch added

#2 follow-up: @SergeyBiryukov
7 years ago

  • Milestone changed from Awaiting Review to 4.0

Related: [11680], [25458].

We didn't add @since for other load_*_textdomain() functions in [25458], so I guess it's not necessary here.

#3 @SergeyBiryukov
7 years ago

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

In 28924:

Document @return value for load_plugin_textdomain(). props jdgrimes.

Document $path parameter for load_child_theme_textdomain().

fixes #28690.

#4 in reply to: ↑ 2 @DrewAPicture
7 years ago

  • Keywords needs-patch added; has-patch removed
  • Resolution fixed deleted
  • Status changed from closed to reopened

Replying to SergeyBiryukov:

Related: [11680], [25458].

We didn't add @since for other load_*_textdomain() functions in [25458], so I guess it's not necessary here.

We probably should have, especially since we're working so hard to make sure our docs are as complete as possible these days :)

Last edited 7 years ago by DrewAPicture (previous) (diff)

@DrewAPicture
7 years ago

This ticket was mentioned in IRC in #wordpress-dev by DrewAPicture. View the logs.


7 years ago

#6 follow-up: @nacin
7 years ago

Given this dates to 2.8, I don't think it's worth trying to go back in time to document changes made long ago. If we're going to do that, we're gonna want to do it for everything.

#7 @SergeyBiryukov
7 years ago

In 28938:

Add @since for get_translations_for_domain().

props DrewAPicture.
see #28690.

#8 in reply to: ↑ 6 @SergeyBiryukov
7 years ago

  • Keywords needs-patch removed
  • Resolution set to fixed
  • Status changed from reopened to closed

Replying to nacin:

Given this dates to 2.8, I don't think it's worth trying to go back in time to document changes made long ago. If we're going to do that, we're gonna want to do it for everything.

Yeah, that's what I thought.

Note: See TracTickets for help on using tickets.