@borrows between two functions
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 15.5k
- Forks
- 1.5k
- Avg merge
- 10d 23h
- Merged PRs (30d)
- 1
Description
I would like to be able to do something like as follows:
/**
* This does that because of stuff.
*/
const foo = () => {}
/**
* @borrow foo
*/
const fooSync = () => {}
IIUC nothing like this is currently possible.
Contributor guide
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
No source file or test is named. Start with the TypeScript example in the issue and trace how JSDoc currently handles documentation tags; done means an @borrow foo annotation lets fooSync reuse foo's documentation, with behavior covered by a test.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100