update EventIter impl docs

src/event/cycle.rs

@@ -97,10 +97,12 @@ impl CycleNoteEvents {
 
 // -------------------------------------------------------------------------------------------------
 
-/// Emits a vector of [`Event`]S from a Tidal [`Cycle`].
+/// Emits a vector of [`EventIterItem`] from a Tidal [`Cycle`].
 ///
 /// Channels from cycle are merged down into note events on different voices.
-/// Float and String targets are currently unsupported and will result into None events.
+/// Values in cycles can be mapped to notes with an optional mapping table.
+///
+/// See also [`ScriptedCycleEventIter`](`super::scripted_cycle::ScriptedCycleEventIter`)
 #[derive(Clone, Debug)]
 pub struct CycleEventIter {
     cycle: Cycle,

src/event/empty.rs

@@ -4,7 +4,7 @@ use crate::{event::EventIter, BeatTimeBase, EventIterItem, PulseIterItem};
 
 // -------------------------------------------------------------------------------------------------
 
-/// Emits an empty, None [`Event`].
+/// Continuously emits empty [`EventIterItem`]S.
 #[derive(Clone, Debug)]
 pub struct EmptyEventIter {}
 

src/event/fixed.rs

@@ -7,7 +7,7 @@ use crate::{
 
 // -------------------------------------------------------------------------------------------------
 
-/// Endlessly emits a single, fixed [`Event`].
+/// Continuously emits a single, fixed [`EventIterItem`].
 #[derive(Clone, Debug)]
 pub struct FixedEventIter {
     events: Vec<Event>,

src/event/mutated.rs

@@ -12,7 +12,7 @@ type EventMapFn = dyn FnMut(Event) -> Event + 'static;
 
 // -------------------------------------------------------------------------------------------------
 
-/// Endlessly emits [`Event`] which's value can be mutated in each iter step
+/// Continuously emits [`EventIterItem`] which's value can be mutated in each iter step
 /// with a custom closure.
 ///
 /// NB: This event iter can not be cloned. `clone_dyn` thus will cause a panic!

src/event/scripted_cycle.rs

@@ -13,7 +13,11 @@ use crate::tidal::{Cycle, Event as CycleEvent, Value as CycleValue};
 
 // -------------------------------------------------------------------------------------------------
 
-/// Emits a vector of [`Event`]S from a Tidal [`Cycle`] with optional mapping callbacks from scripts.
+/// Emits a vector of [`EventIterItem`] from a Tidal [`Cycle`].
+///
+/// Channels from cycle are merged down into note events on different voices.
+/// Values in cycles can be mapped to notes with an optional mapping table or
+/// callbacks from from scripts.
 ///
 /// See also [`CycleEventIter`](`super::cycle::CycleEventIter`)
 #[derive(Clone, Debug)]