WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 2 years ago

#26089 closed defect (bug) (fixed)

Hook Docs (22): wp-admin/includes/template.php

Reported by: shelob9 Owned by: kpdesign
Milestone: 3.9 Priority: normal
Severity: normal Version:
Component: General Keywords: has-patch commit
Focuses: docs, administration Cc:

Description

Will do this today at WordCamp Orlando contributor day.

Attachments (6)

26089.diff (4.4 KB) - added by shelob9 3 years ago.
Inline docs for includes/template.php
26089.2.diff (10.4 KB) - added by shelob9 3 years ago.
Inline docs for all filters and hooks in admin/includes/template.php
26089.3.diff (9.8 KB) - added by kpdesign 3 years ago.
First pass on 26089.2.diff
26089.4.diff (9.1 KB) - added by DrewAPicture 2 years ago.
2nd pass
26089.5.diff (9.2 KB) - added by kpdesign 2 years ago.
Final pass
26089.6.diff (9.7 KB) - added by DrewAPicture 2 years ago.
tweaks

Download all attachments as: .zip

Change History (16)

@shelob9
3 years ago

Inline docs for includes/template.php

#1 @shelob9
3 years ago

  • Keywords has-patch added

All actions documented. Filters documented up to line 90. I will continue working on this soon.

@shelob9
3 years ago

Inline docs for all filters and hooks in admin/includes/template.php

#2 @shelob9
3 years ago

All filters and hooks now have inline docs. Ready for review.

#3 @DrewAPicture
3 years ago

  • Keywords needs-patch added; has-patch removed
  • Owner set to kpdesign
  • Status changed from new to reviewing
  • Summary changed from Hook Docs: wp-admin/includes/template.php to Hook Docs (22): wp-admin/includes/template.php

Hi, thanks for the patch. It looks like you've mixed in functional docs changes which should be removed from this patch. If you wish to improve on those functional docs, feel to open a separate ticket containing those changes.

From looking at 26089.2.diff, looks like there are some spacing and wrapping issues, missing parameter docs, etc. Could do with a full review and a new patch.

@kpdesign
3 years ago

First pass on 26089.2.diff

#4 @kpdesign
3 years ago

  • Keywords has-patch docs-feedback added; needs-patch removed

26089.3.diff removes the functional docs changes, fixes formatting issues, documents all duplicate hooks, and fully documents other blocks.

#5 @jeremyfelt
3 years ago

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

#6 @nacin
2 years ago

  • Component changed from Template to General
  • Focuses administration added

Sorry for the shuffling.

@DrewAPicture
2 years ago

2nd pass

#7 @DrewAPicture
2 years ago

  • Keywords docs-feedback removed

26089.4.diff is a second pass. Clarifies some language and cleans up spacing in a few places. One more once-over should do it them we can check this one in. Needs a review and recommendation.

@kpdesign
2 years ago

Final pass

#8 @kpdesign
2 years ago

  • Keywords commit added

26089.5.diff contains a few minor spacing fixes for a couple blocks in 26089.4.diff.

This one's ready to go in. Recommend commit.

@DrewAPicture
2 years ago

tweaks

#9 @DrewAPicture
2 years ago

  • Milestone changed from Awaiting Review to 3.9

26089.6.diff should do it.

#10 @DrewAPicture
2 years ago

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

In 27237:

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

Props shelob9 for the initial patch. Props kpdesign.
Fixes #26089.

Note: See TracTickets for help on using tickets.