WordPress.org

Make WordPress Core

Opened 22 months ago

Closed 2 months ago

Last modified 2 months ago

#46842 closed defect (bug) (fixed)

Doc: Missing @param in inline document

Reported by: SaeedFard Owned by: SergeyBiryukov
Milestone: 5.6 Priority: normal
Severity: normal Version:
Component: Administration Keywords: has-patch
Focuses: docs, administration Cc:

Description

Missing @param in inline document in wp-admin\includes\class-wp-list-table-compat.php

Attachments (4)

46842.patch (537 bytes) - added by SaeedFard 22 months ago.
46842-2.patch (540 bytes) - added by SaeedFard 22 months ago.
46842-3.patch (595 bytes) - added by SaeedFard 22 months ago.
46842-4.patch (1.7 KB) - added by johannadevos 2 months ago.

Download all attachments as: .zip

Change History (13)

@SaeedFard
22 months ago

@SaeedFard
22 months ago

#1 @swissspidy
22 months ago

  • Keywords needs-refresh added

@SaeedFard In your patch you added $args and $screen, but the actual parameters are $screen and $columns.

Also, patches should follow the PHP documentation standards outlined in https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/.

#2 @SaeedFard
22 months ago

Thanks @swissspidy
I'll update it.

@SaeedFard
22 months ago

#3 @SaeedFard
22 months ago

@swissspidy would you please check the new patch?
Thanks

#4 @desrosj
22 months ago

@SaeedFard The parameters should line up at the $. Also, please add a description for each parameter.

#5 @desrosj
22 months ago

  • Milestone changed from Awaiting Review to Future Release

#6 @johannadevos
2 months ago

I added a patch in which I processed earlier feedback, and also added documentation for the other methods in this class.

#7 @johnbillion
2 months ago

  • Keywords needs-refresh removed

#8 @SergeyBiryukov
2 months ago

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

In 49599:

Docs: Add missing descriptions for _WP_List_Table_Compat methods.

Props johannadevos, SaeedFard, swissspidy, desrosj, SergeyBiryukov.
Fixes #46842.

#9 @SergeyBiryukov
2 months ago

  • Milestone changed from Future Release to 5.6
Note: See TracTickets for help on using tickets.