microsoft / microsoft/TypeScript

Doc comment applied to all components of dotted namespace declaration

Open
#13,855 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Bug Domain: JSDoc Help Wanted
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

TypeScript Version: 2.1.5, 2.2-rc

Code

/** Performance measurements for the compiler. */
namespace ts.performance {}

Expected behavior:
The doc comment should show up in quickinfo/completion for references to the innermost declared namespace performance, but not for ts.

Actual behavior:
The doc comment appears in quickinfo/completion for references to both performance and ts, even though for the outer namespace ts it's most likely irrelevant:
jsdoc

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the dotted namespace example with TypeScript 2.1.5 or 2.2-rc, then trace the quickinfo and completion entry points for the outer and innermost namespace references. Done means the comment appears for performance but not for ts in both quickinfo and completion.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers, devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.