iox-eclipse-iceoryx#2251 Fix wrong documentation in WaitSet example

elBoberido · Apr 14, 2024 · 829578f · 829578f
1 parent d5b5d14
commit 829578f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/iceoryx_examples/waitset/README.md b/iceoryx_examples/waitset/README.md
@@ -323,8 +323,8 @@ for (auto i = 0U; i < NUMBER_OF_SUBSCRIBERS; ++i)
     subscriberVector.emplace_back(iox::capro::ServiceDescription{"Radar", "FrontLeft", "Counter"});
     auto& subscriber = subscriberVector.back();
 
-    /// important: the user has to ensure that the contextData (sumOfAllSamples) lives as long as
-    ///            the subscriber with its callback is attached to the listener
+    /// important: the user has to ensure that the 'contextData' (here 'sumOfAllSamples') lives as long as
+    ///            the subscriber with its callback when attached to the 'waitset'
     waitset
         .attachEvent(subscriber,
                      iox::popo::SubscriberEvent::DATA_RECEIVED,

diff --git a/iceoryx_examples/waitset/ice_waitset_gateway.cpp b/iceoryx_examples/waitset/ice_waitset_gateway.cpp
@@ -90,8 +90,8 @@ int main()
         subscriberVector.emplace_back(iox::capro::ServiceDescription{"Radar", "FrontLeft", "Counter"});
         auto& subscriber = subscriberVector.back();
 
-        /// important: the user has to ensure that the contextData (sumOfAllSamples) lives as long as
-        ///            the subscriber with its callback is attached to the listener
+        /// important: the user has to ensure that the 'contextData' (here 'sumOfAllSamples') lives as long as
+        ///            the subscriber with its callback when attached to the 'waitset'
         waitset
             .attachEvent(subscriber,
                          iox::popo::SubscriberEvent::DATA_RECEIVED,