Skip to content

JSDoc comments in lib.d.ts shouldn't use bare opening HTML tags #38812

Closed
@dabalyan

Description

@dabalyan

TypeScript Version: 3.7.x-dev.201xxxxx

Search Terms: html tags, string typings html tags, doc comments html tags

Code See the open HTML tag <big>

/** Returns a <big> HTML element */
big(): string;

Expected behavior: No open-ended HTML tags in doc-comments

Actual behavior: open-ended HTML tags in doc-comments

Playground Link:

Related Issues:

Metadata

Metadata

Assignees

No one assigned

    Labels

    Domain: lib.d.tsThe issue relates to the different libraries shipped with TypeScriptExperience EnhancementNoncontroversial enhancementsGood First IssueWell scoped, documented and has the green lightHelp WantedYou can do this

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions