chore: review comment

nrkno · Nov 16, 2023 · 20fe31e · 20fe31e
1 parent 589d612
commit 20fe31e
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/packages/timeline-state-resolver/src/integrations/atem/diffState.ts b/packages/timeline-state-resolver/src/integrations/atem/diffState.ts
@@ -9,6 +9,10 @@ import {
 	Mappings,
 } from 'timeline-state-resolver-types'
 
+/**
+  Returns an option object to be passed into AtemState.diffStates().
+  Based on the mappings, these options enables/disables certain areas-of-interest in the diff atem state.
+*/
 export function createDiffOptions(mappings: Mappings): DeepComplete<Diff.SectionsToDiff> {
 	// Find the auxes that have mappings
 	const auxMappings = Object.values<Mapping<unknown>>(mappings)