Skip to content

Commit 8ac7b39

Browse files
committed
chore: minor docs after code review
1 parent 11b7493 commit 8ac7b39

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

packages/job-worker/src/jobs/index.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,13 +104,14 @@ export interface StudioCacheContext {
104104
*/
105105
readonly studioId: StudioId
106106
/**
107-
* The Studio the job belongs to
107+
* The Studio the job belongs to.
108+
* This has any ObjectWithOverrides in their computed/flattened form
108109
*/
109110
readonly studio: ReadonlyDeep<JobStudio>
110111

111112
/**
112-
* // nocommit: so whats the difference between studio and rawStudio?
113113
* The Studio the job belongs to
114+
* This has any ObjectWithOverrides in their original form
114115
*/
115116
readonly rawStudio: ReadonlyDeep<DBStudio>
116117

packages/job-worker/src/workers/caches.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,15 @@ export class WorkerDataCacheWrapperImpl implements WorkerDataCacheWrapper {
100100
* This is a reusable cache of these properties
101101
*/
102102
export interface WorkerDataCache {
103+
/**
104+
* The Studio the cache belongs to
105+
* This has any ObjectWithOverrides in their original form
106+
*/
103107
rawStudio: ReadonlyDeep<DBStudio>
104-
// nocommit: maybe add description of what this is, why is it different from rawStudio
108+
/**
109+
* The Studio the cache belongs to.
110+
* This has any ObjectWithOverrides in their computed/flattened form
111+
*/
105112
jobStudio: ReadonlyDeep<JobStudio>
106113
studioBlueprint: ReadonlyDeep<WrappedStudioBlueprint>
107114
studioBlueprintConfig: ProcessedStudioConfig | undefined

0 commit comments

Comments
 (0)