Creating .d.ts Files from .js files : Half-broken link to "the reference here" (JSDoc)

Open
#3,214 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
typescript
Domain
documentation

Research direction

Start with the linked Creating .d.ts Files from .js files page and inspect its introduction alongside the linked TypeScript Handbook JSDoc pages. Verify the broken supported-jsdoc anchor and update the reference so it reaches the intended JSDoc documentation; done means the link resolves to the relevant reference and the page renders without a broken anchor.

Written by the indexing model from the issue text.

Description

The Creating .d.ts Files from .js files page's introduction reads:

With TypeScript 3.7, TypeScript added support for generating .d.ts files from JavaScript using JSDoc syntax.

This set up means you can own the editor experience of TypeScript-powered editors without porting your project to TypeScript, or having to maintain .d.ts files in your codebase. TypeScript supports most JSDoc tags, you can find the reference here.

The second link's target anchor does not exist anymore, so the link is confusing. The target page now contains the in-jsdoc-references anchor, but looking at the page quickly, it seems like what the link should really point to is the JSDoc Reference page.

By the way
  • The page title's capitalization is inconsistent.
  • TypeScript 3.7 was released in November 2019. The page shouldn't start with that detail, and for sure it shouldn't rely on the 3.7 release notes to document JSDoc support.
Dominant language
TypeScript
Stars
2.6k
Forks
1.5k
Avg merge
1d 12h
Merged PRs (30d)
5

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.

More from microsoft/TypeScript-Website

All issues in microsoft/TypeScript-Website

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.