WordPress.org
Get WordPress

Make WordPress Core

Opened 15 months ago

Closed 6 months ago

Last modified 6 months ago

#59561 closed enhancement (fixed)

Short Description is missing in code comment

Reported by: 1naveengiri's profile 1naveengiri Owned by: sergeybiryukov's profile SergeyBiryukov
Milestone: 6.6 Priority: normal
Severity: normal Version: 6.3.2
Component: General Keywords: has-patch
Focuses: docs, coding-standards Cc:

Description

Short Description helps to understand variable behavior and it seems missing at the following locations.

​https://github.com/WordPress/wordpress-develop/blob/trunk/src/wp-admin/edit-form-advanced.php#L19

​https://github.com/WordPress/wordpress-develop/blob/trunk/src/wp-admin/edit-form-blocks.php#L23

​https://github.com/WordPress/wordpress-develop/blob/trunk/src/wp-admin/edit.php#L35

​https://github.com/WordPress/wordpress-develop/blob/trunk/src/wp-admin/post-new.php#L17

​https://github.com/WordPress/wordpress-develop/blob/trunk/src/wp-admin/post.php#L35

Change History (5)

#1 @sabernhardt
14 months ago

  • Type changed from defect (bug) to enhancement

All of the linked examples include both the $post_type and $post_type_object global variables.

I'm switching the type to enhancement because ​PHP Coding standards note that the description is optional.

This ticket was mentioned in ​PR #6763 on ​WordPress/wordpress-develop by ​@shub07.
7 months ago #2

  • Keywords has-patch added; needs-patch removed

Added missing Doc comments for global Variables as per ticket.

#3 @SergeyBiryukov
6 months ago

  • Milestone changed from Awaiting Review to 6.6

#4 @SergeyBiryukov
6 months ago

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

In 58419:

Docs: Add missing description for a few globals in the admin.

This affects:

  • $post_type
  • $post_type_object
  • $taxonomy
  • $title
  • $wp_meta_boxes

Follow-up to [31121], [32642], [32643], [37890], [43815], [44244], [45742], [53060], [53061], [54831].

Props shub07, 1naveengiri, sabernhardt, SergeyBiryukov.
Fixes #59561.

​@SergeyBiryukov commented on ​PR #6763:
6 months ago #5

Thanks for the PR! Merged in r58419.

Note: See TracTickets for help on using tickets.