From dd9895465c70b2750649e2c0fee4475980e1900d Mon Sep 17 00:00:00 2001
From: jhrdinka <julia.hrdinka@cern.ch>
Date: Thu, 9 Nov 2017 13:25:43 +0100
Subject: [PATCH] Update documentation

---
 Core/include/ACTFW/Framework/Sequencer.hpp | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/Core/include/ACTFW/Framework/Sequencer.hpp b/Core/include/ACTFW/Framework/Sequencer.hpp
index cd3a19be..679175df 100644
--- a/Core/include/ACTFW/Framework/Sequencer.hpp
+++ b/Core/include/ACTFW/Framework/Sequencer.hpp
@@ -84,8 +84,10 @@ public:
   /// Run the event loop over the given number of events.
   ///
   /// @param events (optional) Number of events to process
-  /// @note The event number is optional, for the case that a reader determines
-  /// the event number
+  /// @note This parameter is optional when input is read from a file. In this
+  /// scenario, leaving it unset will process events until the end of the file,
+  /// and setting it will put an upper bound on the number of events to be
+  /// processed.
   /// @param skip Number of events to skip before processing
   ///
   /// This will run all configured algorithms for each event, potentially in
-- 
GitLab