Skip to content

Commit 7360f42

Browse files
committed
Clarify all elements between changes must apply mixing.
Fixes #4914
1 parent 2d95217 commit 7360f42

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

lib/legacy/mutable-data-behavior.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@
4242
* (e.g. `this.notifyPath('items')`) to update the tree. Note that all
4343
* elements that wish to be updated based on deep mutations must apply this
4444
* mixin or otherwise skip strict dirty checking for objects/arrays.
45+
* Specifically, any elements in the binding tree between the source of a
46+
* mutation and the consumption of it must apply this behavior or enable the
47+
* `Polymer.OptionalMutableDataBehavior`.
4548
*
4649
* In order to make the dirty check strategy configurable, see
4750
* `Polymer.OptionalMutableDataBehavior`.
@@ -102,6 +105,9 @@
102105
* (e.g. `this.notifyPath('items')`) to update the tree. Note that all
103106
* elements that wish to be updated based on deep mutations must apply this
104107
* mixin or otherwise skip strict dirty checking for objects/arrays.
108+
* Specifically, any elements in the binding tree between the source of a
109+
* mutation and the consumption of it must enable this behavior or apply the
110+
* `Polymer.OptionalMutableDataBehavior`.
105111
*
106112
* While this behavior adds the ability to forgo Object/Array dirty checking,
107113
* the `mutableData` flag defaults to false and must be set on the instance.

lib/mixins/mutable-data.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@
5757
* (e.g. `this.notifyPath('items')`) to update the tree. Note that all
5858
* elements that wish to be updated based on deep mutations must apply this
5959
* mixin or otherwise skip strict dirty checking for objects/arrays.
60+
* Specifically, any elements in the binding tree between the source of a
61+
* mutation and the consumption of it must apply this mixin or enable the
62+
* `Polymer.OptionalMutableData` mixin.
6063
*
6164
* In order to make the dirty check strategy configurable, see
6265
* `Polymer.OptionalMutableData`.
@@ -132,6 +135,9 @@
132135
* (e.g. `this.notifyPath('items')`) to update the tree. Note that all
133136
* elements that wish to be updated based on deep mutations must apply this
134137
* mixin or otherwise skip strict dirty checking for objects/arrays.
138+
* Specifically, any elements in the binding tree between the source of a
139+
* mutation and the consumption of it must enable this mixin or apply the
140+
* `Polymer.MutableData` mixin.
135141
*
136142
* While this mixin adds the ability to forgo Object/Array dirty checking,
137143
* the `mutableData` flag defaults to false and must be set on the instance.

0 commit comments

Comments
 (0)