WordPress.org
Get WordPress

Make WordPress Core

Opened 10 years ago

Closed 10 years ago

#30149 closed defect (bug) (fixed)

Twenty Fifteen: review documentation and code comments

Reported by: lancewillett's profile lancewillett Owned by: iandstewart's profile iandstewart
Milestone: 4.1 Priority: normal
Severity: normal Version:
Component: Bundled Theme Keywords: has-patch commit
Focuses: docs Cc:

Description

Review doc blocks, code comments, hooks and filters, for correct commenting and documentation.

Attachments (6)

30149.diff​ (3.5 KB) - added by lancewillett 10 years ago.
Quick first pass, needs more eyes
30149.2.diff​ (2.6 KB) - added by MikeHansenMe 10 years ago.
a few more missing periods
30149.3.diff​ (6.6 KB) - added by MikeHansenMe 10 years ago.
https: all the .org things
30149.4.diff​ (30.0 KB) - added by DrewAPicture 10 years ago.
twentyfifteen-comment-menu-number.diff​ (643 bytes) - added by jeherve 10 years ago.
Twenty Fifteen: theme uses wp_nav_menu() in 2 places
30149.5.diff​ (9.1 KB) - added by DrewAPicture 10 years ago.
functionality docs

Download all attachments as: .zip

Change History (27)

#1 @lancewillett
10 years ago

  • Focuses docs added
  • Keywords needs-patch added

See similar task from Twenty Fourteen: #25257.

@lancewillett
10 years ago

Quick first pass, needs more eyes

This ticket was mentioned in ​Slack in #core-themes by lancewillett. ​View the logs.
10 years ago

#3 @iandstewart
10 years ago

@lance looks good to me. @iamtakashi?

#4 @iamtakashi
10 years ago

Looks good to me.

@MikeHansenMe
10 years ago

a few more missing periods

#5 @iandstewart
10 years ago

  • Keywords has-patch commit added; needs-patch removed

#6 @iandstewart
10 years ago

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

In 30233:

Twenty Fifteen: Formatting cleanup for documentation, crossing eyes, dotting tees.

Props lancewillett, MikeHansenMe, fixes #30149.

@MikeHansenMe
10 years ago

https: all the .org things

This ticket was mentioned in ​Slack in #core by mikehansenme. ​View the logs.
10 years ago

#8 @MikeHansenMe
10 years ago

Just found that other ticket about the https all the things relating to 30149.3.diff​. #27115

@DrewAPicture
10 years ago

#9 @DrewAPicture
10 years ago

  • Keywords commit removed
  • Resolution fixed deleted
  • Status changed from closed to reopened

Sorry I didn't come around to this until now. Reopening for some outstanding issues.

30149.4.diff​ addresses removing periods from file header summaries, some spacing, loop documentation, and newlines. It also encorporates @MikeHansenMe's s/http/https changes.

#10 @DrewAPicture
10 years ago

I'm also working on a separate patch for functions.php and the other functionality-based files.

This ticket was mentioned in ​Slack in #core-themes by iandstewart. ​View the logs.
10 years ago

#12 @iandstewart
10 years ago

In 30394:

Twenty Fifteen: doc cleanup, addresses removing periods from file header summaries, some spacing, loop documentation, and https instead of http.

Props DrewAPicture, MikeHansenMe, see #30149.

#13 @iandstewart
10 years ago

  • Keywords needs-patch added; has-patch removed

Removing has-patch and adding needs-patch for @DrewAPicture's upcoming functions doc updates.

#14 @jeherve
10 years ago

I attached a diff for another small change when registering the 2 menus.

@jeherve
10 years ago

Twenty Fifteen: theme uses wp_nav_menu() in 2 places

@DrewAPicture
10 years ago

functionality docs

#16 @DrewAPicture
10 years ago

  • Keywords has-patch commit added; needs-patch removed

As promised, 30149.5.diff​ contains docs fixes for functionality in the theme. Includes changes to functions.php, as well as all four files in /inc.

This ticket was mentioned in ​Slack in #core-themes by iandstewart. ​View the logs.
10 years ago

This ticket was mentioned in ​Slack in #core-themes by iandstewart. ​View the logs.
10 years ago

#19 @iandstewart
10 years ago

Corrected the number of menus in r30568, props jeherve.

#20 @iandstewart
10 years ago

In 30569:

Twenty Fifteen: docs correction and cleanup.

Props DrewAPicture, see #30149.

#21 @iandstewart
10 years ago

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

Closing up this ticket for now, we can reopen it if we find any more docs needing cleanup, or open a new specific ticket.

Note: See TracTickets for help on using tickets.