WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 2 years ago

Last modified 2 years 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 3 years 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 3 years ago.
Comprehensive pass
25257.2.diff (38.4 KB) - added by DrewAPicture 2 years ago.
Docs only

Download all attachments as: .zip

Change History (15)

#1 @lancewillett
3 years ago

In 25769:

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

#2 @lancewillett
3 years ago

  • Cc lancewillett added
  • Keywords needs-patch added

@celloexpressions
3 years ago

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

#3 @celloexpressions
3 years ago

Noticed a couple things, fixed in 25257.1.diff.

#4 @lancewillett
3 years ago

In 25792:

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

#5 @valeriosza
3 years ago

  • Keywords close added

#6 @kpdesign
3 years ago

  • Keywords close removed

@DrewAPicture
3 years ago

Comprehensive pass

#7 @DrewAPicture
3 years 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 :)

#8 @DrewAPicture
2 years ago

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

@DrewAPicture
2 years ago

Docs only

#9 @DrewAPicture
2 years ago

  • Keywords commit added

25257.2.diff is ready to go.

#10 @celloexpressions
2 years 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).

#11 @DrewAPicture
2 years ago

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

Fixed in [26556].

#12 @lancewillett
2 years ago

Thanks Drew, wrong ticket link. :)

Note: See TracTickets for help on using tickets.