WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

#26149 closed defect (bug) (fixed)

Hook Docs (13): wp-admin/includes/image-edit.php

Reported by: theorboman Owned by: kpdesign
Milestone: 3.9 Priority: normal
Severity: normal Version:
Component: Media Keywords: has-patch commit
Focuses: docs Cc:
PR Number:

Description

Documenting all undocumented filter hooks in wp-admin/includes/image-edit.php

Attachments (5)

26149.patch (4.8 KB) - added by theorboman 6 years ago.
Patch for inline docs
26149-1.patch (4.7 KB) - added by theorboman 6 years ago.
Updated patch for wp-admin/includes/image-edit.php. Added periods after variable descriptions as per standards. Also note that 'admin_memory_limit' is documented in wp-includes/class-wp-image-editor-imagick.php (see https://core.trac.wordpress.org/ticket/26177)
26149.2.diff (4.5 KB) - added by theorboman 6 years ago.
Use spaces, not tabs to space out the inline comments.
26149.diff (5.3 KB) - added by DrewAPicture 6 years ago.
3rd pass
26149.3.diff (6.0 KB) - added by kpdesign 6 years ago.
Final pass

Download all attachments as: .zip

Change History (15)

@theorboman
6 years ago

Patch for inline docs

#1 @theorboman
6 years ago

  • Keywords has-patch added

#2 @markoheijnen
6 years ago

  • Milestone changed from Awaiting Review to 3.8

Personally I rather have jpeg_quality description in /wp-includes/class-wp-image-editor.php. See #25721

#3 @DrewAPicture
6 years ago

  • Owner set to DrewAPicture
  • Status changed from new to reviewing

@theorboman
6 years ago

Updated patch for wp-admin/includes/image-edit.php. Added periods after variable descriptions as per standards. Also note that 'admin_memory_limit' is documented in wp-includes/class-wp-image-editor-imagick.php (see https://core.trac.wordpress.org/ticket/26177)

#4 @DrewAPicture
6 years ago

  • Milestone changed from 3.8 to Awaiting Review

#5 @DrewAPicture
6 years ago

  • Summary changed from Hooks Docs: wp-admin/includes/image-edit.php to Hook Docs (13): wp-admin/includes/image-edit.php

At a glance, the docs here look fairly complete, though the spacing is a little wonky. Perhaps you were using tabs instead of spaces or something. I'll see if I can get you a more thorough review today.

@theorboman
6 years ago

Use spaces, not tabs to space out the inline comments.

#6 @theorboman
6 years ago

Here's another patch for this using spaces, not tabs for spacing out the docs. Let me know if this isn't the right way to do it!

#7 @jeremyfelt
6 years ago

  • Component changed from Inline Docs to Media
  • Focuses docs added

@DrewAPicture
6 years ago

3rd pass

#8 @DrewAPicture
6 years ago

  • Milestone changed from Awaiting Review to 3.9
  • Owner changed from DrewAPicture to kpdesign

26149.diff Should do it. Just needs a last review and recommendation.

@kpdesign
6 years ago

Final pass

#9 @kpdesign
6 years ago

  • Keywords commit added

26149.3.diff contains a few tweaks to 26149.diff.

This should be good to go. Recommend commit.

#10 @DrewAPicture
6 years ago

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

In 27357:

Inline documentation for hooks in wp-admin/includes/image-edit.php.

Props theorboman. Props kpdesign for the cleanup.
Fixes #26149.

Note: See TracTickets for help on using tickets.