-
-
Notifications
You must be signed in to change notification settings - Fork 200
Open
Description
Description
Several spelling mistakes were found in JSDoc comments across 4 .d.ts type
declaration files in the packages/concerto-core/types/ directory.
These are not trivial, JSDoc comments in .d.ts files are part of the
developer-facing API documentation and appear directly in IDE tooltips and
autocomplete hints when developers use this library. Typos here affect the
experience of every consumer of the package.
Typos Found
| File | Typo | Correction |
|---|---|---|
lib/model/relationship.d.ts |
Contructs |
Constructs |
lib/model/relationship.d.ts |
compatability (×2) |
compatibility |
lib/model/typed.d.ts |
Overriden |
Overridden |
lib/serializer/objectvalidator.d.ts |
resouce (×2) |
resource |
lib/serializer/resourcevalidator.d.ts |
resouce (×2) |
resource |
Important Note
Since these are generated .d.ts files, the same typos likely exist in the
original source files that generated them. If those aren't fixed too, the
typos will return the next time types are regenerated. It would be worth
checking and fixing the source files as part of resolving this issue.
Impact
- No functional or logic changes
- Affects IDE developer experience (tooltips, autocomplete, hover docs)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels