Opened 4 months ago
Closed 5 weeks ago
#65259 closed defect (bug) (fixed)
Docs: Fix inline comment typos in build_query_vars_from_query_block() in blocks.php
| Reported by: | deepakrohilla | Owned by: | westonruter |
|---|---|---|---|
| Priority: | normal | Milestone: | 7.1 |
| Component: | Editor | Version: | 6.5 |
| Severity: | normal | Keywords: | has-patch |
| Cc: | Focuses: | docs |
Description (last modified by )
In src/wp-includes/blocks.php, the inline comment inside build_query_vars_from_query_block() contains two errors:
- "before hand" should be "beforehand" (compound adverb)
- "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 (7)
This ticket was mentioned in PR #11851 on WordPress/wordpress-develop by @deepakrohilla.
4 months ago
#1
#2
@
4 months ago
- Component General → Editor
- Milestone Awaiting Review → 7.1
- Owner set to
- Status assigned → reviewing
- Version trunk → 6.5
#3
@
4 months ago
- Description modified (diff)
- r48141 included sentences starting with "It detects" for the function summaries of
register_block_script_handle()andregister_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).
@westonruter commented on PR #11851:
5 weeks ago
#6
Note: Ignore the changes I've made outside of src/wp-includes/blocks.php. I'll commit those separately. As part of reviewing the docs, I've been improving the documented types for the touched functions.
![(please configure the [header_logo] section in trac.ini)](/chrome/site/your_project_logo.png)
https://core.trac.wordpress.org/ticket/65259