jsr-io / jsr

The open-source package registry for modern JavaScript and TypeScript
https://jsr.io
MIT License
2.34k stars 102 forks source link

The documentation should show the possible exceptions when available #597

Open felds opened 3 months ago

felds commented 3 months ago

Currently, the generated docs only show generics, parameters and return types. Having the possible exceptions listed could be useful when using a library.

The @throws tag is currently badly supported but this could change if tools made any use of it.

MDN list the possible exceptions under the return types and I think it's a good standard for any documentation. Examples:

lucacasonato commented 2 months ago

cc @crowlKats