Make WordPress Core

Opened 9 months ago

Closed 8 months ago

Last modified 6 months ago

#58858 closed defect (bug) (fixed)

Docs: Wrap broken inline `@see` tags with curly braces.

Reported by: costdev's profile costdev Owned by: audrasjb's profile audrasjb
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:


Docs umbrella ticket for 6.4: #58833

Change History (8)

This ticket was mentioned in PR #4870 on WordPress/wordpress-develop by @costdev.


9 months ago
#1

This wraps inline @see tags in curly braces to fix broken references on DevHub.

#2 @Hareesh Pillai
9 months ago

  • Keywords good-first-bug added

#3 @audrasjb
9 months ago

  • Keywords good-first-bug removed

Removing good first bug tag, as we already have a patch.

#4 @audrasjb
9 months ago

  • Owner set to audrasjb
  • Status changed from new to reviewing

#5 @mukesh27
8 months ago

  • Keywords commit added

Thanks @costdev for the ticket. PR got enough approval and ready for merge.

#6 @audrasjb
8 months ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 56434:

Docs: Wrap inline @see tags in curly braces.

Props costdev, mukesh27.
Fixes #58858.
See #58833.

#8 @johnbillion
6 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.

Note: See TracTickets for help on using tickets.