WordPress.org
Get WordPress

Make WordPress Core

Opened 3 weeks ago

Last modified 3 weeks ago

#65259 reviewing defect (bug)

Docs: Fix inline comment typos in build_query_vars_from_query_block() in blocks.php

Reported by: deepakrohilla's profile deepakrohilla Owned by: westonruter's profile westonruter
Milestone: 7.1 Priority: normal
Severity: normal Version: 6.5
Component: Editor Keywords: has-patch
Focuses: docs Cc:

Description (last modified by sabernhardt)

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”.

Change History (3)

#2 @westonruter
3 weeks ago

  • Component changed from General to Editor
  • Milestone changed from Awaiting Review to 7.1
  • Owner set to westonruter
  • Status changed from assigned to reviewing
  • Version changed from trunk to 6.5

#3 @sabernhardt
3 weeks ago

  • Description modified (diff)
  • 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).
  • 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).
Note: See TracTickets for help on using tickets.