WordPress.org

Make WordPress Core

Opened 7 months ago

Closed 4 months ago

Last modified 4 months ago

#25257 closed defect (bug) (fixed)

Twenty Fourteen: Docs review

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

Description

Creating this as a reminder to do a docs review of Twenty Fourteen per the inline docs standards when it's closer to release for 3.8.

Attachments (3)

25257.1.diff (1.6 KB) - added by celloexpressions 6 months ago.
Fix a reference to Twenty Eleven, update customize function description and add comments to each action within twentyfourteen_customize_register.
25257.diff (62.1 KB) - added by DrewAPicture 5 months ago.
Comprehensive pass
25257.2.diff (38.4 KB) - added by DrewAPicture 4 months ago.
Docs only

Download all attachments as: .zip

Change History (15)

comment:1 lancewillett6 months ago

In 25769:

Twenty Fourteen: first pass for updating code comments to reflect WP inline docs standards, see #25257.

comment:2 lancewillett6 months ago

  • Cc lancewillett added
  • Keywords needs-patch added

celloexpressions6 months ago

Fix a reference to Twenty Eleven, update customize function description and add comments to each action within twentyfourteen_customize_register.

comment:3 celloexpressions6 months ago

Noticed a couple things, fixed in 25257.1.diff.

comment:4 lancewillett6 months ago

In 25792:

Twenty Fourteen: minor fixes to docs, props celloexpressions. See #25257

comment:5 valeriosza6 months ago

  • Keywords close added

comment:6 kpdesign5 months ago

  • Keywords close removed

DrewAPicture5 months ago

Comprehensive pass

comment:7 DrewAPicture5 months ago

  • Keywords has-patch added; needs-patch removed

25257.diff is a comprehensive pass of all theme files that covers:

  • Adding some inline comments
  • Doc block fixes throughout, especially in /inc/ files
  • Indentation inside of if statements
  • Standardizes on if/endif inside template files

In reference to the last two points, I was reading everything line by line anyway, so I just did those too :)

comment:8 DrewAPicture5 months ago

I'll rework this patch tonight to make it easy to push through.

DrewAPicture4 months ago

Docs only

comment:9 DrewAPicture4 months ago

  • Keywords commit added

25257.2.diff is ready to go.

comment:10 celloexpressions4 months ago

The comment for twentyfourteen_widgets_init() says two widget areas, but there are actually three (that line is changed in 25257.2.diff, so probably easiest to fix on commit).

comment:11 DrewAPicture4 months ago

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

Fixed in [26556].

comment:12 lancewillett4 months ago

Thanks Drew, wrong ticket link. :)

Note: See TracTickets for help on using tickets.