-- docs fix some minor issues (#684)

* -- docs fix some minor issues * -- docs removed legacy note forbidding mixed sync operation --------- Co-authored-by: Breitsprecher, Konrad <[email protected]>
vectorgrp · Oct 4, 2023 · e5e0b0c · e5e0b0c
1 parent 3095e17
commit e5e0b0c
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 8 deletions.
diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst
@@ -20,14 +20,16 @@ Fixed
 ~~~~~
 
 - Fixed misbehavior of the sil-kit-system-controller in interactive mode on user input:
+
   - The sil-kit-system-controller now triggers a Stop() in SystemState::Running or SystemState::Paused.
   - The sil-kit-system-controller only triggers AbortSimulation when not SystemState::Running, SystemState::Paused, SystemState::Shutdown or SystemState::Aborting.
 
 Changed
 ~~~~~~~
 
-- Performance improvement of the interal serialization
+- Performance improvement of the internal serialization
 - The final state handling of the sil-kit-system-controller in interactive mode on user input has changed:
+
   - Old: The sil-kit-system-controller triggered AbortSimulation if the finalState was not received after 5s. 
   - New: The sil-kit-system-controller retries receiving the finalState 3x5s. If this fails, the sil-kit-system-controller triggers AbortSimulation (if not already happened) and tries receiving the finalState 3x5s again. If this fails, the sil-kit-system-controller just terminates.
 
@@ -50,7 +52,7 @@ Fixed
 
 - Ensured that calling ``ISystemController::AbortSimulation()`` does not lead to the system controller terminating
   prior to other participants receiving its abort message.
-- Ensure that userContext field for external CanFrameTransmitEvents is allways null.
+- Ensure that userContext field for external CanFrameTransmitEvents is always null.
 - Fixed warning in VS2017 (x86) build  
 
 [4.0.34] - 2023-08-21
@@ -140,6 +142,7 @@ Added
 ~~~~~
 
 - Improved Lifecycle and TimeSyncService features:
+
   - Full support for Operation Mode Autonomous with TimeSyncService including hopping onto / leaving a running simulation
   - Abort simulation in case Coordinated participants want to join a running simulation
   - Abort simulation in case an Autonomous with TimeSyncService sees an incompatible participant 

diff --git a/docs/api/pubsub.rst b/docs/api/pubsub.rst
@@ -140,7 +140,7 @@ The interfaces for the publish/subscribe mechanism can be instantiated from an |
     // Participant1 (Publisher)
     // ------------------------
     SilKit::Services::PubSub::PubSubSpec pubDataSpec{"Topic1", "application/json"};
-    pubDataSpec.AddLabel("KeyA", "ValA");
+    pubDataSpec.AddLabel("KeyA", "ValA", SilKit::Services::MatchingLabel::Kind::Optional);
     auto* publisher = participant->CreateDataPublisher("PubCtrl1", pubDataSpec, 1);
     publisher->Publish(user_data);
 

diff --git a/docs/simulation/simulation.rst b/docs/simulation/simulation.rst
@@ -202,11 +202,6 @@ The following first gives a general overview of a simulation run using the |Prod
 Afterwards, possibilities to configure the simulation step length of a simulation step and to define the simulation step that is being executed are introduced.
 The last part details what time information |ProductName| clients provide, depending on their synchronization mode.
 
-.. admonition:: Note
-
-    A mixed operation mode, where some participants operate synchronized and some unsynchronized,
-    is not supported. Therefore, all participants of a simulation must either be synchronized or unsynchronized.
-
 .. _subsec:sim-overview:
 
 Simulation Overview