Make WordPress Core

Opened 12 years ago

Closed 12 years ago

#30825 closed defect (bug) (fixed)

Update inline docs for wp-admin/includes/upgrade.php

Reported by: morganestes Owned by: DrewAPicture
Priority: normal Milestone: 4.2
Component: Upgrade/Install Version: 4.2
Severity: normal Keywords: has-patch
Cc: Focuses: docs

Description

There are several stubs for documenting upgrade functions with short and long descriptions. This patch is an effort to update those docblocks with accurate descriptions where I can, update blocks that have inaccurate @param and @return info, and add an additional block where one was missing.

Attachments (4)

30825.diff​ (2.1 KB ) - added by morganestes 12 years ago.
30825.2.diff​ (5.3 KB ) - added by morganestes 12 years ago.
Updated diff with all changes.
30825.3.diff​ (12.5 KB ) - added by morganestes 12 years ago.
30825.4.diff​ (8.8 KB ) - added by morganestes 12 years ago.
Better diff from Git with --no-prefix flag.

Download all attachments as: .zip

Change History (7)

@morganestes
12 years ago

@morganestes
12 years ago

Updated diff with all changes.

@morganestes
12 years ago

#1 @morganestes
12 years ago

  • Keywords has-patch added

This is the first time I've used Git to create a new branch for a ticket. I didn't realize that trying to create a patch would be so difficult with multiple commits to that branch, but I think I finally got all my changes in the .3.diff patch.

@morganestes
12 years ago

Better diff from Git with --no-prefix flag.

#2 @nacin
12 years ago

  • Component General → Upgrade/Install
  • Milestone Awaiting Review → 4.2
  • Owner set to DrewAPicture
  • Status new → assigned

#3 @DrewAPicture
12 years ago

  • Resolution → fixed
  • Status assigned → closed

In 31246:

Add missing summaries and descriptions for various functions in wp-admin/includes/upgrade.php.

Also generally improve existing parameter, return, and other documentation in various function DocBlocks.

Props morganestes.
Fixes #30825.

Note: See TracTickets for help on using tickets.