You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Why
Asked claude to audit the docblocks for incorrect or missing info. This is what it mentioned as being good improvements.
# How
Update docblocks.
# Test Plan
Proofread.
Copy file name to clipboardExpand all lines: packages/entity/src/Entity.ts
+6Lines changed: 6 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -32,6 +32,12 @@ import { ViewerContext } from './ViewerContext';
32
32
*
33
33
* All concrete entity implementations should extend this class and provide their
34
34
* own EntityCompanionDefinition.
35
+
*
36
+
* Generic type parameters:
37
+
* TFields - the shape of the underlying data for this entity, typically corresponding to a database table schema. The mapping from TFields to the actual database schema is defined in the EntityCompanionDefinition for this entity.
38
+
* TIDField - the key of the ID field in TFields, which must be non-nullable and is used to uniquely identify individual entities
39
+
* TViewerContext - the type of ViewerContext that can be used with this entity
40
+
* TSelectedFields - the keys of fields in TFields that belong to this entity; used when there are multiple entities backed by the same underlying table with different field subsets
0 commit comments