#58858 closed defect (bug) (fixed)
Docs: Wrap broken inline `@see` tags with curly braces.
| Reported by: | costdev | Owned by: | audrasjb |
|---|---|---|---|
| Priority: | normal | Milestone: | 6.4 |
| Component: | General | Version: | |
| Severity: | normal | Keywords: | has-patch commit |
| Cc: | Focuses: | docs |
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
$argsparameter). - 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.
3 years ago
#1
#3
@
3 years ago
- Keywords good-first-bug removed
Removing good first bug tag, as we already have a patch.
#5
@
3 years ago
- Keywords commit added
Thanks @costdev for the ticket. PR got enough approval and ready for merge.
@audrasjb commented on PR #4870:
3 years ago
#7
committed in https://core.trac.wordpress.org/changeset/56434
#8
@
3 years 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.
![(please configure the [header_logo] section in trac.ini)](/chrome/site/your_project_logo.png)
This wraps inline
@seetags in curly braces to fix broken references on DevHub.