From 5e33019784de15c1fc9d2566ae2b410faf37ac99 Mon Sep 17 00:00:00 2001
From: Sergey Borisov <S.Borisov@evision-software.com>
Date: Mon, 29 Jan 2018 15:49:43 +0300
Subject: [PATCH] Passive event storage abstraction documentation should
 clearly define expectations on the way data is loaded.

---
 .../PollingEventStoreAdapter.cs                      | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/Src/LiquidProjections.PollingEventStore/PollingEventStoreAdapter.cs b/Src/LiquidProjections.PollingEventStore/PollingEventStoreAdapter.cs
index f36f108..c3dd8cd 100644
--- a/Src/LiquidProjections.PollingEventStore/PollingEventStoreAdapter.cs
+++ b/Src/LiquidProjections.PollingEventStore/PollingEventStoreAdapter.cs
@@ -440,6 +440,18 @@ public void Dispose()
     /// </summary>
     public interface IPassiveEventStore
     {
+        /// <summary>
+        /// Loads <see cref="Transaction"/>s from the storage in the order that they should be projected (should be the same order that they were persisted).
+        /// </summary>
+        /// <remarks>
+        /// The implementation is allowed to return just a limited subset of items at a time.
+        /// It is up to the implementation to decide how many items should be returned at a time.
+        /// The only requirement is that the implementation should return at least one <see cref="Transaction"/>,
+        /// if there are any transactions having checkpoint (<see cref="Transaction.Checkpoint"/>) bigger than given one.
+        /// </remarks>
+        /// <param name="checkpoint">
+        ///  Determines the value of the  <see cref="Transaction.Checkpoint"/>, next to which <see cref="Transaction"/>s should be loaded from the storage.
+        /// </param>
         IEnumerable<Transaction> GetFrom(long? checkpoint);
     }
 }