Question: tsdoc for function type declaration
Open
Nobody has claimed this yet.
general discussion
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
export type OnEnter = (success: boolean) => void;
export interface OnLeave {
(success: boolean): void
}
How should we reasonably add the type declaration of the above function type 'OnEnter' and 'OnLeave' ?
I tried as follows:
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
Review the TSDoc guidance for documenting the TypeScript function type declarations shown in the issue, including both OnEnter and OnLeave. Done means the project has a decided, documented syntax or recommendation for these declarations; no repository files or tests are identified in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100