Skip to content

Duplicated documentation from common properties in union types #35170

Closed
@SimonSiefke

Description

@SimonSiefke

TS template added by @mjbvz

TypeScript Version: 3.8.0-dev.20191116

Search Terms:

  • suggest / suggestions
  • jsdoc

duplicate-description

  • VSCode Version: 1.41.0-insider
  • OS Version: Ubuntu 19.04

Steps to Reproduce:

  1. Create a typescript union type with descriptions for each type, e.g.
export type DocumentFilter = {
    /** A language id, like `typescript`. */
    language: string;
    /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
    scheme?: string;
    /** A glob pattern, like `*.{ts,js}`. */
    pattern?: string;
} | {
    /** A language id, like `typescript`. */
    language?: string;
    /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
    scheme: string;
    /** A glob pattern, like `*.{ts,js}`. */
    pattern?: string;
} | {
    /** A language id, like `typescript`. */
    language?: string;
    /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
    scheme?: string;
    /** A glob pattern, like `*.{ts,js}`. */
    pattern: string;
};
  1. When using intellisense, it shows duplicate descriptions

Does this issue occur when all extensions are disabled?: Yes

Metadata

Metadata

Labels

BugA bug in TypeScriptDomain: Quick Infoe.g. hover text, tool-tips, and tooltips.Fix AvailableA PR has been opened for this issueHelp WantedYou can do this

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions