From 4459741200510b165cda0182129e2291b7244f40 Mon Sep 17 00:00:00 2001 From: Andrew Duthie Date: Fri, 3 Nov 2017 15:43:24 -0400 Subject: [PATCH] Utils: Update dirtying reducer documentation --- editor/utils/dirtying-reducer/index.js | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/editor/utils/dirtying-reducer/index.js b/editor/utils/dirtying-reducer/index.js index 71c18a3f690278..dcb29b33147983 100644 --- a/editor/utils/dirtying-reducer/index.js +++ b/editor/utils/dirtying-reducer/index.js @@ -4,12 +4,13 @@ import { includes } from 'lodash'; /** - * Reducer enhancer which transforms the result of the original reducer into an - * object tracking its own history (past, present, future). + * Reducer enhancer for tracking changes to reducer state over time. The + * returned reducer will include a new `isDirty` property on the object + * reflecting whether the original reference of the reducer has changed. * * @param {Function} reducer Original reducer * @param {?Object} options Optional options - * @param {?Array} options.resetTypes Action types upon which to clear past + * @param {?Array} options.resetTypes Action types upon which to reset dirty * @return {Function} Enhanced reducer */ export default function dirtyingReducer( reducer, options = {} ) {