Make WordPress Core

Opened 10 years ago

Closed 10 years ago

#29111 closed defect (bug) (fixed)

In /wp-admin/user, not all files are documented consistently

Reported by: nikv's profile NikV Owned by: kpdesign's profile kpdesign
Milestone: 4.1 Priority: normal
Severity: normal Version: 3.8
Component: Users Keywords: has-patch
Focuses: docs Cc:

Description

In /wp-admin/user, the first few files (about.php, credits.php, freedoms.php, index.php) have a simple code snippet at the beginning of the file as shown below.

/** Load WordPress Administration Bootstrap */
require_once( dirname( __FILE__ ) . '/admin.php' );

But in that same folder, there are a few files that do not have the same documentation (above the require_once) as the rest. I think to keep up with consistency of inline documentation, the rest of the files (in that folder) should be documented the same way if they have the same code snippet. I have attached the files that did not have the inline docs, but now do.

Attachments (3)

index.php.diff (347 bytes) - added by NikV 10 years ago.
profile.php.diff (355 bytes) - added by NikV 10 years ago.
user-edit.php.diff (363 bytes) - added by NikV 10 years ago.

Download all attachments as: .zip

Change History (7)

@NikV
10 years ago

@NikV
10 years ago

@NikV
10 years ago

#1 @NikV
10 years ago

  • Keywords has-patch added

#2 @tellyworth
10 years ago

  • Version changed from trunk to 3.8

#3 @DrewAPicture
10 years ago

  • Component changed from General to Users
  • Milestone changed from Awaiting Review to 4.1
  • Owner set to kpdesign
  • Status changed from new to reviewing

#4 @DrewAPicture
10 years ago

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

In 30228:

Ensure the requires for the admin bootstrap are documented in all wp-admin/user/ files.

Props NikV for the initial patch.
Fixes #29111.

Note: See TracTickets for help on using tickets.