microsoft / microsoft/tsdoc

Support full doc inheritance

Open
#307 0 comments 4 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

The spec contains @inheritDoc, which has the purpose for object-oriented inheritance of methods where only @params, @returns etc. are copied, but no other tags.

It would be great if it was possible to copy the entire doc of a symbol without copy/pasting it, in order to reduce duplicates and make maintenance easier.

Example case: I'm currently documenting the structure of the parsed result of an XML file using TypeScript interfaces (which are only for typing, they don't get implemented). Here i'm adding comments and other information from the XML reference document about the file. I then create classes to interact with the parsed XML, which should inherit the same documentation about the purpose of fields / properties than those on the interfaces.

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 with the specification’s @inheritDoc behavior and the parser’s handling of doc tags; the issue names no files or tests. Compare interface and class documentation in the XML example, then determine how full-symbol copying should differ from copying @params and @returns. Done means the behavior is specified and supported without duplicated comments, with coverage for the example.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.