Skip to content

Adequate our use of @link tag #14334

@oandregal

Description

@oandregal

The spec defines block and inline tags. @block stand on their own, inline tags live within the description of block level tags and are wrapped by {}. Example:

@block-tag {type} A description with {@inline-tag} within it.

It looks like @link is an inline-only tag. Tools actually implement the @link as block and inline, so it's a non-issue at a practical level.

Action items

Bad:

/**
 * Handles a delete keyDown event to handle merge or removal for collapsed
 * selection where caret is at directional edge: forward for a delete key,
 * reverse for a backspace key.
 *
 * @link https://en.wikipedia.org/wiki/Caret_navigation
 *
 * @param {KeyboardEvent} event Keydown event.
 */

Good:

/**
 * Handles a delete keyDown event to handle merge or removal for collapsed
 * selection where caret is at directional edge: forward for a delete key,
 * reverse for a backspace key.
 *
 * @see https://en.wikipedia.org/wiki/Caret_navigation
 *
 * @param {KeyboardEvent} event Keydown event.
 */

Metadata

Metadata

Assignees

No one assigned

    Labels

    Good First IssueAn issue that's suitable for someone looking to contribute for the first timeNeeds DevReady for, and needs developer efforts[Tool] Docgen/packages/docgen[Type] EnhancementA suggestion for improvement.

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions