WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 3 years ago

#37520 closed defect (bug) (fixed)

Remove @since references to "Menu Customizer"

Reported by: celloexpressions Owned by: westonruter
Milestone: 4.7 Priority: normal
Severity: normal Version: 4.3
Component: Customize Keywords: good-first-bug has-patch
Focuses: docs Cc:

Description

I just noticed that there are some @since references to "Menu Customizer" in wp-admin/js/customize-nav-menus.js. These should have been changed to @since 4.3.0 when the Menu Customizer plugin was merged into core. Might be worth searching for this in other files as well.

Attachments (2)

37520.patch (1.3 KB) - added by gma992 3 years ago.
changed to @since 4.3.0 Menu Customizer and some formatting love
37520.1.diff (1.2 KB) - added by gma992 3 years ago.
Ops, removed Menu Customizer comment, not necessary.

Download all attachments as: .zip

Change History (9)

@gma992
3 years ago

changed to @since 4.3.0 Menu Customizer and some formatting love

@gma992
3 years ago

Ops, removed Menu Customizer comment, not necessary.

#1 @gma992
3 years ago

  • Keywords has-patch added; needs-patch removed

#2 @celloexpressions
3 years ago

  • Focuses docs added

Thanks for the patch @gma992!

@DrewAPicture do we need the empty line above the @since? Does everything else look good to you here?

#3 @DrewAPicture
3 years ago

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

@celloexpressions The "blank line above the @since" is where the (missing) short descriptions live ;)

Assigning to mark the good-first-bug as "claimed."

#4 follow-up: @celloexpressions
3 years ago

Actually, looks like most of the functions have ashort description but it's now below @since. @gma992 do you want to take a stab at adding descriptions where they're missing? If not I can add those to your patch. And then I think the @since should go under the descriptions where they occur, since they're all probably intended to be short descriptions.

#5 in reply to: ↑ 4 @gma992
3 years ago

Replying to celloexpressions:

Indeed, as @DrewAPicture says the empty space is intended to write down the missing descriptions, feel free to go ahead and modify whatever you feel like :)

#6 @westonruter
3 years ago

  • Milestone changed from Future Release to 4.7
  • Owner changed from gma992 to westonruter
  • Status changed from assigned to accepted

#7 @westonruter
3 years ago

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

In 38300:

Docs: Update jsdoc in customize-nav-menus.js to remove references to Menu Customizer plugin.

Also fix @param for updateAssignedLocationsInSectionTitle.

Props gma992, westonruter.
Fixes #37520.

Note: See TracTickets for help on using tickets.