WordPress.org

Make WordPress Core

Opened 7 years ago

Closed 7 years ago

Last modified 7 years ago

#25504 closed defect (bug) (fixed)

Hook Docs: wp-includes/class-wp-image-editor.php

Reported by: tomauger Owned by: DrewAPicture
Milestone: 3.7 Priority: normal
Severity: normal Version:
Component: Inline Docs Keywords: has-patch
Focuses: Cc:

Description

Inline documentation for filters: 'wp_editor_set_quality' and 'image_editor_default_mime_type'

Attachments (3)

class-wp-image-editor.php.patch (1.1 KB) - added by tomauger 7 years ago.
Inline docs for filters
25504.docs.diff (1.6 KB) - added by gayadesign 7 years ago.
PHP Docs indentation
25504.diff (1.4 KB) - added by DrewAPicture 7 years ago.
tabs for the major indents

Download all attachments as: .zip

Change History (12)

@tomauger
7 years ago

Inline docs for filters

#1 @DrewAPicture
7 years ago

  • Keywords has-patch added
  • Owner set to DrewAPicture
  • Status changed from new to reviewing

#2 @DrewAPicture
7 years ago

  • Milestone changed from Awaiting Review to 3.7

class-wp-image-editor.php.patch looks good to me. Thanks for the patch :)

#3 @DrewAPicture
7 years ago

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

In 25705:

Inline documentation for hooks in wp-includes/class-wp-image-editor.php.

Props tomauger.
Fixes #25504

@gayadesign
7 years ago

PHP Docs indentation

#4 @gayadesign
7 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

Fixed the indentation for the PHP Docs.

#5 follow-up: @tomauger
7 years ago

Thanks! Good to know for the next ones. So to be clear - the indentation is at the same level as the function doc block?

@DrewAPicture
7 years ago

tabs for the major indents

#6 in reply to: ↑ 5 @DrewAPicture
7 years ago

Replying to tomauger:

Thanks! Good to know for the next ones. So to be clear - the indentation is at the same level as the function doc block?

No, 25504.docs.diff wasn't quite correct either.

It's tab indentation up to alignment with the entity, whether that be the filter, action or function declaration line, etc. The patch from @gayadesign was partially correct in that there should be a space before the * in docblock lines. Note the spaces added in 25504.diff.

#7 @DrewAPicture
7 years ago

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

In 25714:

Fix phpdoc indentation for hooks in wp-includes/class-wp-image-editor.php.

Props gayadesign.
Fixes #25504.

#8 follow-up: @tomauger
7 years ago

Thanks for the additional clarifications. So my original indentation was correct, except that I was missing a space before the subsequent *s. I want to avoid making the same mistakes in the future.

#9 in reply to: ↑ 8 @DrewAPicture
7 years ago

Replying to tomauger:

Thanks for the additional clarifications. So my original indentation was correct, except that I was missing a space before the subsequent *s. I want to avoid making the same mistakes in the future.

Yup, that was it. Thanks for the patches and the effort :)

Note: See TracTickets for help on using tickets.