RFC: @throws tag for documenting exceptions
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
In https://github.com/microsoft/tsdoc/issues/8#issuecomment-510733311 @bookmoons said:
I vote for
@throws, or some other way to document exceptions. Really useful when coding against a procedure to know which kind of errors I should be handling.
I've opened this issue so we can have a more focused discussion.
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
Read the referenced TSDoc issue comment and the discussion on this issue first. Review how the TSDoc standard currently represents tags and exceptions, then determine the intended syntax and semantics for an @throws tag. Done requires a settled proposal rather than an implementation task.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100