WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

Last modified 6 years ago

#30508 closed defect (bug) (fixed)

PHPDoc @param fixes

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

Description

Attached patch corrects 3 PHPDoc @param types of: wp_autosave(), image_edit_apply_changes() and image_constrain_size_for_editor().

Attachments (2)

30508.diff (1.7 KB) - added by tillkruess 6 years ago.
30508.2.diff (1.7 KB) - added by tillkruess 6 years ago.
added description for $changes parameter in image_edit_apply_changes()

Download all attachments as: .zip

Change History (10)

@tillkruess
6 years ago

#1 @DrewAPicture
6 years ago

  • Keywords has-patch added
  • Type changed from enhancement to defect (bug)
  • Version trunk deleted

#2 @DrewAPicture
6 years ago

  • Keywords needs-patch added; has-patch removed

Hi Till, thanks for the patch. Since we're modifying the type for the $changes parameter in image_edit_apply_changes(), would you mind also writing a description for that as well as the $image parameter?

@tillkruess
6 years ago

added description for $changes parameter in image_edit_apply_changes()

#3 @tillkruess
6 years ago

Done. I used the same description the wp_image_editor_before_change action used inside image_edit_apply_changes().

#4 @DrewAPicture
6 years ago

  • Keywords has-patch added; needs-patch removed
  • Milestone changed from Awaiting Review to 4.1

Great, thanks for doing that.

#5 @DrewAPicture
6 years ago

In 30644:

Improve the inline documentation for image_edit_apply_changes().

Including:

  • Add a correct type (array) for the $changes parameter
  • Add the @since version
  • Add proper descriptions for both parameters and the return value.

Props tillkruess for the initial patch.
See #30508.

#6 @DrewAPicture
6 years ago

In 30645:

Specify a type (array) for the $post_data parameter in the DocBlock for wp_autosave().

Props tillkruess.
See #30508.

#7 @DrewAPicture
6 years ago

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

In 30646:

Improve inline documentation for image_constrain_size_for_editor().

Includes:

  • Proper formatting, plus adding a type for the $context parameter
  • Inline @see tags in the description and backtick-escaping inline code
  • Parameter, type, and description alignment

Props tillkruess for the initial patch.
Fixes #30508.

#8 @tillkruess
6 years ago

Awesome, thanks for the commits!

Note: See TracTickets for help on using tickets.