[wp-trac] [WordPress Trac] #65259: Docs: Fix inline comment typos in build_query_vars_from_query_block() in blocks.php

[WordPress Trac]

#65259: Docs: Fix inline comment typos in build_query_vars_from_query_block() in
blocks.php
---------------------------+--------------------------
 Reporter:  deepakrohilla  |       Owner:  westonruter
     Type:  defect (bug)   |      Status:  reviewing
 Priority:  normal         |   Milestone:  7.1
Component:  Editor         |     Version:  6.5
 Severity:  normal         |  Resolution:
 Keywords:  has-patch      |     Focuses:  docs
---------------------------+--------------------------

Old description:

> In src/wp-includes/blocks.php, the inline comment inside
> build_query_vars_from_query_block() contains two errors: (1) "before
> hand" should be "beforehand" (compound adverb), and It detects when a
> path to file was provided  from this "It" should be removed.
>
> WordPress inline documentation standards, especially for DocBlocks.
> In WordPress coding standards:
> The description section should continue naturally and should not start
> with “It”.

New description:

 In `src/wp-includes/blocks.php`, the inline comment inside
 `build_query_vars_from_query_block()` contains two errors:
 1. "before hand" should be "beforehand" (compound adverb)
 2. "It detects when a path to file was provided...": from this "It" should
 be removed.

 WordPress inline documentation standards, especially for DocBlocks.
 In WordPress coding standards:
 The description section should continue naturally and should not start
 with “It”.

--

Comment (by sabernhardt):

 - [https://core.trac.wordpress.org/changeset/48141/trunk/src/wp-
 includes/blocks.php r48141] included sentences starting with "It detects"
 for the function summaries of `register_block_script_handle()` and
 `register_block_style_handle()` (in WordPress 5.5).
 - r55447 added the comment with "before hand" (WP 6.2).
 - [https://core.trac.wordpress.org/changeset/57565/trunk/src/wp-
 includes/blocks.php r57565] added `register_block_script_module_id()` (WP
 6.5). In addition to starting the second sentence with "It detects", the
 summary includes "under with" ("under" was not removed).

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