Explain the "dispose" method appropriately (twbs#30838)

olsza · Oct 3, 2020 · cbed636 · cbed636
1 parent f85e98f
commit cbed636
Show file tree

Hide file tree

Showing 9 changed files with 9 additions and 9 deletions.
diff --git a/site/content/docs/5.0/components/alerts.md b/site/content/docs/5.0/components/alerts.md
@@ -127,7 +127,7 @@ This makes an alert listen for click events on descendant elements which have th
         <code>dispose</code>
       </td>
       <td>
-        Destroys an element's alert.
+        Destroys an element's alert. (Removes stored data on the DOM element)
       </td>
     </tr>
     <tr>

diff --git a/site/content/docs/5.0/components/buttons.md b/site/content/docs/5.0/components/buttons.md
@@ -155,7 +155,7 @@ var bsButton = new bootstrap.Button(button)
         <code>dispose</code>
       </td>
       <td>
-        Destroys an element's button.
+        Destroys an element's button. (Removes stored data on the DOM element)
       </td>
     </tr>
   </tbody>

diff --git a/site/content/docs/5.0/components/carousel.md b/site/content/docs/5.0/components/carousel.md
@@ -368,7 +368,7 @@ var carousel = new bootstrap.Carousel(myCarousel, {
     </tr>
     <tr>
       <td><code>dispose</code></td>
-      <td>Destroys an element's carousel.</td>
+      <td>Destroys an element's carousel. (Removes stored data on the DOM element)</td>
     </tr>
     <tr>
       <td><code>getInstance</code></td>

diff --git a/site/content/docs/5.0/components/collapse.md b/site/content/docs/5.0/components/collapse.md
@@ -224,7 +224,7 @@ var bsCollapse = new bootstrap.Collapse(myCollapse, {
     </tr>
     <tr>
       <td><code>dispose</code></td>
-      <td>Destroys an element's collapse.</td>
+      <td>Destroys an element's collapse. (Removes stored data on the DOM element)</td>
     </tr>
     <tr>
       <td><code>getInstance</code></td>

diff --git a/site/content/docs/5.0/components/dropdowns.md b/site/content/docs/5.0/components/dropdowns.md
@@ -949,7 +949,7 @@ Note when `boundary` is set to any value other than `'scrollParent'`, the style
     <tr>
       <td><code>dispose</code></td>
       <td>
-        Destroys an element's dropdown.
+        Destroys an element's dropdown. (Removes stored data on the DOM element)
       </td>
     </tr>
     <tr>

diff --git a/site/content/docs/5.0/components/modal.md b/site/content/docs/5.0/components/modal.md
@@ -928,7 +928,7 @@ Manually readjust the modal's position if the height of a modal changes while it
 
 #### dispose
 
-Destroys an element's modal.
+Destroys an element's modal. (Removes stored data on the DOM element)
 
 {{< highlight js >}}myModal.dispose(){{< /highlight >}}
 

diff --git a/site/content/docs/5.0/components/popovers.md b/site/content/docs/5.0/components/popovers.md
@@ -323,7 +323,7 @@ Toggles an element's popover. **Returns to the caller before the popover has act
 
 #### dispose
 
-Hides and destroys an element's popover. Popovers that use delegation (which are created using [the `selector` option](#options)) cannot be individually destroyed on descendant trigger elements.
+Hides and destroys an element's popover (Removes stored data on the DOM element). Popovers that use delegation (which are created using [the `selector` option](#options)) cannot be individually destroyed on descendant trigger elements.
 
 {{< highlight js >}}myPopover.dispose(){{< /highlight >}}
 

diff --git a/site/content/docs/5.0/components/scrollspy.md b/site/content/docs/5.0/components/scrollspy.md
@@ -290,7 +290,7 @@ dataSpyList.forEach(function (dataSpyEl) {
 
 #### dispose
 
-Destroys an element's scrollspy.
+Destroys an element's scrollspy. (Removes stored data on the DOM element)
 
 #### getInstance
 

diff --git a/site/content/docs/5.0/components/tooltips.md b/site/content/docs/5.0/components/tooltips.md
@@ -330,7 +330,7 @@ Toggles an element's tooltip. **Returns to the caller before the tooltip has act
 
 #### dispose
 
-Hides and destroys an element's tooltip. Tooltips that use delegation (which are created using [the `selector` option](#options)) cannot be individually destroyed on descendant trigger elements.
+Hides and destroys an element's tooltip (Removes stored data on the DOM element). Tooltips that use delegation (which are created using [the `selector` option](#options)) cannot be individually destroyed on descendant trigger elements.
 
 {{< highlight js >}}tooltip.dispose(){{< /highlight >}}