#58858 closed defect (bug) (fixed)
Docs: Wrap broken inline `@see` tags with curly braces.
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | 6.4 | Priority: | normal |
Severity: | normal | Version: | |
Component: | General | Keywords: | has-patch commit |
Focuses: | docs | Cc: |
Description
There are approximately 19 instances in Core where @see
does not occur at the beginning of a line, and is not wrapped in curly braces. The parser on DevHub doesn't recognise these, and so a literal @see <name>
appears on the page.
See here for some examples:
- Language_Pack_Upgrader::bulk_upgrade()
- Walker_Category_Checklist::start_lvl() (Look at the
$args
parameter). - is_front_page()
Docs umbrella ticket for 6.4: #58833
Change History (8)
This ticket was mentioned in PR #4870 on WordPress/wordpress-develop by @costdev.
21 months ago
#1
#3
@
21 months ago
- Keywords good-first-bug removed
Removing good first bug tag, as we already have a patch.
#5
@
20 months ago
- Keywords commit added
Thanks @costdev for the ticket. PR got enough approval and ready for merge.
@audrasjb commented on PR #4870:
20 months ago
#7
committed in https://core.trac.wordpress.org/changeset/56434
#8
@
18 months ago
There's 43 instances of See {@see <function>()}
in core, but ~250 for something like See [a-zA-Z0-9:_]+\(\)
which matches See <function>()
.
Perhaps we should remove all instances of See {@see <function>()}
and use See <function>()
instead as it makes the sentence in the source code more readble.
This wraps inline
@see
tags in curly braces to fix broken references on DevHub.