[wp-trac] [WordPress Trac] #57840: Docblock improvements for 6.3

WordPress Trac noreply at wordpress.org
Thu May 18 15:43:28 UTC 2023


#57840: Docblock improvements for 6.3
----------------------------+-------------------------------------
 Reporter:  hellofromTonya  |       Owner:  (none)
     Type:  task (blessed)  |      Status:  new
 Priority:  normal          |   Milestone:  6.3
Component:  General         |     Version:
 Severity:  normal          |  Resolution:
 Keywords:  has-patch       |     Focuses:  docs, coding-standards
----------------------------+-------------------------------------

Comment (by Presskopp):

 More 'a' => 'an' candidates:

 \src\wp-admin\includes\class-bulk-upgrader-skin.php
         Line  82:               // Nothing, This will be displayed within
 a iframe.

 \src\wp-admin\includes\class-pclzip.php
         Line  637:   //                read_error : the file was not
 extracted because there was a error

 \src\wp-admin\includes\class-wp-filesystem-base.php
         Line 401:        * Converts *nix-style file permissions to a octal
 number.

 \src\wp-admin\includes\file.php
         Line 1380:      // Check for a edge-case affecting PHP Maths
 abilities.

 \src\wp-admin\includes\update-core.php
         Line 1499:                                      // If a error
 occurs partway through this final step, keep the error flowing through,
 but keep process going.

 \src\wp-includes\class-wp-http-cookie.php
         Line 139:                               // Handle the cookie
 ending in ; which results in a empty final pair.

 \src\wp-includes\class-wp-http.php
         Line 1083:       * '4' or '6' to represent a IPv4 and IPv6 address
 respectively.

 \src\wp-includes\class-wp-oembed.php
         Line 517:        * Connects to a oEmbed provider and returns the
 result.

 \src\wp-includes\media-template.php
         Line   11:  * Outputs the markup for a audio tag to be used in an
 Underscore template

 \src\wp-includes\media.php
         Line 4814:  * Checks the HTML content for a audio, video, object,
 embed, or iframe tags.

 \src\wp-includes\option.php
         Line 1373:  * Removes a option by name for the current network.

 \src\wp-includes\Requests\src\IdnaEncoder.php
         Line  29:        * Maximum length of a IDNA URL in ASCII.

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/57840#comment:47>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list