-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Adequate our use of @link tag #14334
Copy link
Copy link
Closed
Labels
Good First IssueAn issue that's suitable for someone looking to contribute for the first timeAn issue that's suitable for someone looking to contribute for the first timeNeeds DevReady for, and needs developer effortsReady for, and needs developer efforts[Tool] Docgen/packages/docgen/packages/docgen[Type] EnhancementA suggestion for improvement.A suggestion for improvement.
Metadata
Metadata
Assignees
Labels
Good First IssueAn issue that's suitable for someone looking to contribute for the first timeAn issue that's suitable for someone looking to contribute for the first timeNeeds DevReady for, and needs developer effortsReady for, and needs developer efforts[Tool] Docgen/packages/docgen/packages/docgen[Type] EnhancementA suggestion for improvement.A suggestion for improvement.
Type
Fields
Give feedbackNo fields configured for issues without a type.
The spec defines block and inline tags.
@blockstand on their own, inline tags live within the description of block level tags and are wrapped by{}. Example:It looks like
@linkis an inline-only tag. Tools actually implement the@linkas block and inline, so it's a non-issue at a practical level.Action items
@linktagWhen the link tag is used as a block-level tag, we should substitute it by theFix: change block-level @link tag to @see tag #15616@seetag instead.Bad:
Good: