[wp-trac] [WordPress Trac] #59651: Docblock improvements for 6.5
WordPress Trac
noreply at wordpress.org
Thu Nov 9 09:49:55 UTC 2023
#59651: Docblock improvements for 6.5
----------------------------+-------------------------------------
Reporter: hellofromTonya | Owner: (none)
Type: task (blessed) | Status: new
Priority: normal | Milestone: 6.5
Component: General | Version:
Severity: normal | Resolution:
Keywords: has-patch | Focuses: docs, coding-standards
----------------------------+-------------------------------------
Comment (by SergeyBiryukov):
In [changeset:"57099" 57099]:
{{{
#!CommitTicketReference repository="" revision="57099"
Docs: Fix various incorrect WP-flavored array specifications.
Tags like `@string` or `@array` do not exist and are not supported. The
way these were used here, also meant duplicate information being
documented.
Fixed now by using the `@type` tag as per the WP flavor of array
documentation.
Includes some fixes to the documentation formatting.
Reference: [https://developer.wordpress.org/coding-standards/inline-
documentation-standards/php/#1-1-parameters-that-are-arrays PHP
Documentation Standards: Parameters That Are Arrays].
Follow-up to [33322], [42880], [42971], [44786].
Props jrf.
See #59651.
}}}
--
Ticket URL: <https://core.trac.wordpress.org/ticket/59651#comment:7>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list