What is the shortest/fastest way to extract a function’s documentation by name?

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python, typescript
Domain
documentation

Research direction

Start with index.ts and the demo, tracing how the known main function name is used to obtain its documentation. Confirm the shortest supported TypeScript approach and whether the demo can run without requiring python2; done means the extraction path and demo requirement are clarified or updated.

Written by the indexing model from the issue text.

Description

Given index.ts and the known "main" function name:

/**
 * Init the app
 * @example main()
 */
export function main(): void {};

What is the shortest amount of code to extract the function’s documentation? I looked at the demo and it seems quite verbose to just extract some data.

Side note: the demo requires python2 to be available, which is not ideal and requires that I edit it manually

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

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/tsdoc

All issues in microsoft/tsdoc

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.