Opened 4 weeks ago
Closed 4 weeks ago
#64524 closed defect (bug) (fixed)
Incorrect @see tag syntax - wp_enqueue_code_editor()
| Reported by: |
|
Owned by: |
|
|---|---|---|---|
| Milestone: | 7.0 | Priority: | normal |
| Severity: | minor | Version: | |
| Component: | General | Keywords: | has-patch |
| Focuses: | docs | Cc: |
Description
The PHPDoc for wp_enqueue_code_editor() includes this see tag: @see wp_get_code_editor_settings();.
The @see tag should reference the function signature (including parentheses for functions/methods) but should not include a trailing semicolon as it is not part of the referenced symbol. The trailing semicolon also violates WP inline documentation standards.
Impact
- May cause issues with documentation parsers and static analysis tools that expect a symbol reference
Proposed Change
Change the current tag
@see wp_get_code_editor_settings();
To:
@see wp_get_code_editor_settings()
Notes
- File location:
wp-includes/general-template.php. - A search for
@see.*;didn’t turn up any other instances of@seereferences ending with a semicolon in the code base.
Change History (3)
This ticket was mentioned in PR #10748 on WordPress/wordpress-develop by @marian1.
4 weeks ago
#1
- Keywords has-patch added
Note: See
TracTickets for help on using
tickets.
Trac ticket: https://core.trac.wordpress.org/ticket/64524