microsoft / microsoft/tsdoc

Question: tsdoc for function param type

Open
#186 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

/**
 * doc for `a`,`b`, and `c` here:
 */
function foo({
  a,
  b,
  c
}:{
  a: string,
  b: number,
  c: string
}){

}

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

Read the TSDoc specification and the destructured TypeScript example in issue #186. Determine whether documentation for parameters a, b, and c is defined by the standard; done means recording a clear answer or identifying the documentation or specification change required.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.