From 5398a96cc63ac3a524ea981ae30bb8b168c696b6 2021-11-12 13:46:39 From: MH Date: 2021-11-12 13:46:39 Subject: [PATCH] Small edit to comments --- diff --git a/src/runtime2/native.rs b/src/runtime2/native.rs index 48e2428f48d7dd91f2efd6535ee7e4d07a5f0f63..e17481fd34027ccea8b01922c9bf820b8c76e02c 100644 --- a/src/runtime2/native.rs +++ b/src/runtime2/native.rs @@ -409,7 +409,6 @@ impl ApplicationInterface { /// Creates a new connector. Note that it is not scheduled immediately, but /// depends on the `ApplicationConnector` to run, followed by the created /// connector being scheduled. - // TODO: Yank out scheduler logic for common use. pub fn create_connector(&mut self, module: &str, routine: &str, arguments: ValueGroup) -> Result<(), ComponentCreationError> { if self.is_in_sync { return Err(ComponentCreationError::InSync); @@ -450,6 +449,7 @@ impl ApplicationInterface { /// run the synchronous behaviour in blocking fashion. The results *must* be /// retrieved using `try_wait` or `wait` for the interface to be considered /// in non-sync mode. + // TODO: Maybe change API in the future. For now it does the job pub fn perform_sync_round(&mut self, actions: Vec) -> Result<(), ApplicationStartSyncError> { if self.is_in_sync { return Err(ApplicationStartSyncError::AlreadyInSync); @@ -492,7 +492,8 @@ impl ApplicationInterface { return Ok(()) } - /// Wait until the next sync-round is finished + /// Wait until the next sync-round is finished, returning the received + /// messages in order of `get` calls. pub fn wait(&mut self) -> Result, ApplicationEndSyncError> { if !self.is_in_sync { return Err(ApplicationEndSyncError::NotInSync);