WordPress.org

Make WordPress Core

Opened 5 months ago

Closed 7 weeks 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:

Description

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

Attachments (5)

26149.patch (4.8 KB) - added by theorboman 5 months ago.
Patch for inline docs
26149-1.patch (4.7 KB) - added by theorboman 5 months 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 4 months ago.
Use spaces, not tabs to space out the inline comments.
26149.diff (5.3 KB) - added by DrewAPicture 7 weeks ago.
3rd pass
26149.3.diff (6.0 KB) - added by kpdesign 7 weeks ago.
Final pass

Download all attachments as: .zip

Change History (15)

theorboman5 months ago

Patch for inline docs

comment:1 theorboman5 months ago

  • Keywords has-patch added

comment:2 markoheijnen5 months 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

comment:3 DrewAPicture5 months ago

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

theorboman5 months 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)

comment:4 DrewAPicture5 months ago

  • Milestone changed from 3.8 to Awaiting Review

comment:5 DrewAPicture4 months 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.

theorboman4 months ago

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

comment:6 theorboman4 months 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!

comment:7 jeremyfelt3 months ago

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

DrewAPicture7 weeks ago

3rd pass

comment:8 DrewAPicture7 weeks 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.

kpdesign7 weeks ago

Final pass

comment:9 kpdesign7 weeks ago

  • Keywords commit added

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

This should be good to go. Recommend commit.

comment:10 DrewAPicture7 weeks 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.