microsoft / microsoft/tsdoc

@link resolution questions and possible bug (tsdoc reference resolutions)

Open
#342 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5k
Forks
162
Avg merge
17h 24m
Merged PRs (30d)
8

Description

So this is actually TypeDoc that is producing the issue, but as it says they say they are using the standard set for resolving links from tsdoc itself (and because they haven't responded to the issue itself), I figured I'd post it here in case it is a tsdoc issue!

If it is an issue and it would save significant time to submit a PR I will if it actually is reviewed but with typedoc not responding I didn't want to waste my time for something that might be ignored :-)

If you guys could please review the detailed issue https://github.com/TypeStrong/typedoc/issues/2141 I would appreciate it. I confirmed its an issue that isnt vscode or typescript compiler itself as a typescript team member indicated it is a bug in either tsdoc or typedoc and not either of those (they validate as expected by the typescript team member)

  • I am guessing this is actually typedoc since I (think) the compiler adhered to typedoc for handling its doc links standard?
  • Original Issue on TypeDoc Repo: https://github.com/TypeStrong/typedoc/issues/2141
  • Basically if you reference an imported value using @link it will not resolve unless you import directly (rather than import * as)
import (type?) * as enums from '../enums'; // doesnt work if you import type or import direct

/** {@link enums.MyEnum} or {@link enums.MyEnum MyEnum} does not resolve on docs but does on vscode */

/** {@link MyEnum} does not resolve on vscode (it uses global reference lookup in docs so it resolves in docs) */
  • so you have to choose if you want links to work in docs OR when using the code in IDE :(

Contributor guide

No contributing guide indexed for this repository

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 reviewing the linked TypeDoc issue 2141 and reproducing the shown @link cases with namespace and direct imports. Done means determining whether TSDoc owns the unresolved namespace-import behavior and documenting or implementing an agreed resolution.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.