What is the shortest/fastest way to extract a function’s documentation by name?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- python, typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100