WordPress.org

Make WordPress Core

Opened 19 months ago

Closed 19 months ago

Last modified 19 months ago

#41108 closed enhancement (fixed)

Better documentation for the labels array of get_taxonomy_labels() function

Reported by: truongwp Owned by: DrewAPicture
Milestone: 4.9 Priority: normal
Severity: normal Version: 3.0
Component: Taxonomy Keywords: has-patch
Focuses: docs Cc:

Description

Make documentation for the labels array of get_taxonomy_labels() function better and remove @todo tag.

Attachments (1)

41108.diff (5.5 KB) - added by truongwp 19 months ago.

Download all attachments as: .zip

Change History (8)

@truongwp
19 months ago

#1 @truongwp
19 months ago

  • Keywords has-patch added

#2 @netweb
19 months ago

  • Milestone changed from Awaiting Review to 4.9

#3 @DrewAPicture
19 months ago

  • Version changed from trunk to 3.0

Hi @truongwp, thanks for the patch. I think you're on the right track, though it's a bit misleading to document the labels as first-level properties of the WP_Taxonomy object, which they really aren't.

So rather than document $tax, I think the most straightforward way to do it would be to document all of the labels in the @return notation instead.

#4 @truongwp
19 months ago

Hi @DrewAPicture,

I had a bit confusion here. I will update the patch.

Thank you.

#5 @DrewAPicture
19 months ago

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

In 40944:

Docs: Add full documentation for members in the labels object returned by get_taxonomy_labels().

Props truongwp.
Fixes #41108.

#6 @DrewAPicture
19 months ago

@truongwp Thanks for the initial patch!

#7 @truongwp
19 months ago

@DrewAPicture Thank you for completing the patch. I'm busy so not can't complete it.

Note: See TracTickets for help on using tickets.