Skip to content

Commit

Permalink
Updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
William Troup committed Jan 8, 2024
1 parent 5c32c87 commit f2ba246
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/CHANGE_LOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**
Expand Down
2 changes: 1 addition & 1 deletion docs/PUBLIC_FUNCTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Pauses all the watches for a specific number of milliseconds.
<br>

### **resumeWatch( *id* )**:
Resumes the all the watches that are currently paused.
Resumes all the watches that are currently paused.
<br>
***Parameter: id***: '*string*' - The ID of the object being watched, or DOM element ID being watched.
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/binding/options/OPTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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). |

<br/>
Expand Down
2 changes: 1 addition & 1 deletion src/observe.js
Original file line number Diff line number Diff line change
Expand Up @@ -688,7 +688,7 @@
/**
* resumeWatches().
*
* Resumes the all the watches that are currently paused.
* Resumes all the watches that are currently paused.
*
* @public
*
Expand Down

0 comments on commit f2ba246

Please sign in to comment.