docs: improve packages jsdoc docs#957
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #957 +/- ##
==========================================
+ Coverage 92.94% 93.35% +0.41%
==========================================
Files 26 26
Lines 595 632 +37
Branches 99 99
==========================================
+ Hits 553 590 +37
Misses 33 33
Partials 9 9
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
14269dc to
58a6c5f
Compare
omermorad
approved these changes
Dec 9, 2025
6d0cf64 to
5c1f860
Compare
5c1f860 to
5223a20
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
Documentation: Adds comprehensive JSDoc documentation across all public API packages with practical examples, cross-references, and links to suites.dev documentation.
What is the current behavior?
Public API types, methods, and interfaces across all Suites packages lack comprehensive JSDoc documentation. This makes it difficult for developers to understand the purpose, usage, and benefits of each API without referring to external documentation.
Issue Number: N/A
What is the new behavior?
@suites/unit- TestBed API, types, and error classes@suites/core- UnitReference, TestBedBuilder, MockOverride interfaces@suites/doubles.jest,@suites/doubles.sinon,@suites/doubles.vitest- Adapter exports and type augmentations@suites/di.nestjs,@suites/di.inversify- DI adapter documentation@suites/types.common,@suites/types.doubles- Base types and error documentation@seelinks to relevant suites.dev documentation pages@sinceversion tags for API versioning@throwsdocumentation for error conditionsscripts/validate-tsdoc-links.ts)Does this PR introduce a breaking change?
Other information
This PR also includes minor fixes discovered during documentation work:
stubvariable in doubles packagesunit.d.tsdeclaration filesThe new TSDoc validation script can be run to check for broken
{@link}URLs in documentation comments across all packages.