From f2ba24610430f6935bef4b9911126aea822c6eea Mon Sep 17 00:00:00 2001 From: William Troup Date: Mon, 8 Jan 2024 17:01:01 +0000 Subject: [PATCH] Updated documentation. --- docs/CHANGE_LOG.md | 2 +- docs/PUBLIC_FUNCTIONS.md | 2 +- docs/binding/options/OPTIONS.md | 2 +- src/observe.js | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/CHANGE_LOG.md b/docs/CHANGE_LOG.md index 8cfde0d..42aaec2 100644 --- a/docs/CHANGE_LOG.md +++ b/docs/CHANGE_LOG.md @@ -3,7 +3,7 @@ ## Version 0.6.0: #### **Binding Options / Function Options:** -- Added a new binding/option called "allowCanceling", which states the watch can be canceled (defaults to true). +- Added a new binding/option called "allowCanceling", which states the watch can be cancelled (defaults to true). - Added a new binding/option called "allowPausing", which states the watch can be paused (defaults to true). #### **Public Functions:** diff --git a/docs/PUBLIC_FUNCTIONS.md b/docs/PUBLIC_FUNCTIONS.md index 90d7a68..4ad7478 100644 --- a/docs/PUBLIC_FUNCTIONS.md +++ b/docs/PUBLIC_FUNCTIONS.md @@ -64,7 +64,7 @@ Pauses all the watches for a specific number of milliseconds.
### **resumeWatch( *id* )**: -Resumes the all the watches that are currently paused. +Resumes all the watches that are currently paused.
***Parameter: id***: '*string*' - The ID of the object being watched, or DOM element ID being watched.
diff --git a/docs/binding/options/OPTIONS.md b/docs/binding/options/OPTIONS.md index df7fe7e..2b384cc 100644 --- a/docs/binding/options/OPTIONS.md +++ b/docs/binding/options/OPTIONS.md @@ -17,7 +17,7 @@ Below is a list of all the options supported in the "data-observe-watch-options" | *number* | maximumChangesBeforeCanceling | States the total number of changes that are allowed before the watch is cancelled (defaults to 0, which is off) | | *number* | pauseTimeoutOnChange | States the delay (in milliseconds) that should be used before checking for changes again after a change is detected (defaults to 0, which is off) | | *string[]* | propertyNames | States the property names that should be watched for changes (defaults to all). | -| *boolean* | allowCanceling | States if the watch can be canceled (defaults to true). | +| *boolean* | allowCanceling | States if the watch can be cancelled (defaults to true). | | *boolean* | allowPausing | States if the watch can be paused (defaults to true). |
diff --git a/src/observe.js b/src/observe.js index 8a174b1..105f35d 100644 --- a/src/observe.js +++ b/src/observe.js @@ -688,7 +688,7 @@ /** * resumeWatches(). * - * Resumes the all the watches that are currently paused. + * Resumes all the watches that are currently paused. * * @public *