Make WordPress Core

Opened 10 years ago

Closed 10 years ago

#27346 closed defect (bug) (fixed)

Remove redundancy of inline docs in class-wp-list-table.php

Reported by: bravokeyl's profile bravokeyl Owned by: sergeybiryukov's profile SergeyBiryukov
Milestone: 3.9 Priority: normal
Severity: normal Version:
Component: Administration Keywords: has-patch
Focuses: docs Cc:

Description

I don't know whether it is intentionally there or not but removing the top one

/**
 * Base class for displaying a list of items in an ajaxified HTML table.
 *
 * @package WordPress
 * @subpackage List_Table
 * @since 3.1.0
 */

/**
 * Base class for displaying a list of items in an ajaxified HTML table.
 *
 * @package WordPress
 * @subpackage List_Table
 * @since 3.1.0
 * @access private
 */

Attachments (1)

27346.patch (481 bytes) - added by bravokeyl 10 years ago.

Download all attachments as: .zip

Change History (6)

@bravokeyl
10 years ago

#1 @kpdesign
10 years ago

  • Component changed from General to Administration
  • Keywords has-patch added
  • Type changed from enhancement to defect (bug)
  • Version 3.8.1 deleted

#2 @SergeyBiryukov
10 years ago

  • Milestone changed from Awaiting Review to 3.9

Introduced in [15958] (where the file also contained a few helper functions) and [16127] (where the functions were moved into a separate file).

#3 @SergeyBiryukov
10 years ago

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

In 27502:

Remove duplicate description of WP_List_Table class.

props bravokeyl.
fixes #27346.

#4 @DrewAPicture
10 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

Whether to defer to class-level docblocks in favor of all files having a file header has not been decided. On the one hand, yes it seems like duplication, however the blocks serve different purposes.

I've added this to the agenda for tomorrow's inline docs chat at 19:00 UTC in #wordpress-sfd

Version 0, edited 10 years ago by DrewAPicture (next)

#5 @DrewAPicture
10 years ago

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

The decision was made for all functional files to retain their file headers. We'll restore a modified version of the file header here when we cover the other list table classes. Reclosing.

Note: See TracTickets for help on using tickets.