Repository navigation
Improve JSDoc #41
Description
As the API reference will be auto-generated with TypeDoc, we want to improve the JSDoc to add more information to the documentation. we want to add the following changes:
- Add JSDoc to all assertion classes
- Add
@paramto all generic types - Add
@exampleto all assertion matcher methods to show their usage in the documentation - Change
@linkof built-in data types to link to the official JavaScript documentation.- For instance,
{@link Error}should point to the MDN Error docs
- For instance,
Activity
neolight1010 commentedon Oct 4, 2022
Hello! I'm currently working on this issue and will be sending a PR in the following days 😄
github-actions commentedon Jul 28, 2023
🎉 This issue has been resolved in version 1.3.0 🎉
The release is available on:
Your semantic-release bot 📦🚀
github-actions commentedon Feb 19, 2024
🎉 This issue has been resolved in version 1.0.0 🎉
The release is available on:
Your semantic-release bot 📦🚀