Adds documentation for patch

mikesol · May 23, 2021 · c98c3cb · c98c3cb
1 parent 79d52fa
commit c98c3cb
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/src/WAGS/Patch.purs b/src/WAGS/Patch.purs
@@ -640,6 +640,7 @@ instance toGraphEffectsMakeWaveShaper :: (IsSymbol ptr, IsSymbol sym, IsOversamp
     oversample' = reflectOversample (mempty :: oversample)
 
 class Patch g0 g1 where
+  -- | Take any frame from `g0` to `g1`. The compiler automatically determines the necessary operations to perform the transformation.
   patch :: forall env audio engine proof m res. Monad m => AudioInterpret audio engine => FrameT env audio engine proof m res { | g0 } { | g1 } Unit
 
 instance patchAll ::