Skip to content

Commit 7475427

Browse files
committed
Properly explain why Migrate() has a return value
1 parent f47dde9 commit 7475427

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

Refresh.Workers/MigrationJob.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@ public override void ExecuteJob(WorkContext context)
5656
/// <returns>
5757
/// The number of entities in the batch, minus the number of entities removed from DB during this migration.
5858
/// E.g. if 1000 items are in the given batch, and 5 got removed from DB during migration,
59-
/// the returned number will be 1000 - 5 = 995
59+
/// the returned number will be 1000 - 5 = 995.
60+
/// This allows you to write migration jobs, which need to delete entities from the given batch, without breaking pagination done by the worker.
6061
/// </returns>
6162
protected abstract int Migrate(WorkContext context, TEntity[] batch);
6263
}

0 commit comments

Comments
 (0)