Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updates to observe list documentation

  • Loading branch information...
commit fa5004348fc7d981b3a1001b913a31679528f55f 1 parent 29b8d83
@imjoshdean imjoshdean authored
Showing with 5 additions and 4 deletions.
  1. +5 −4 observe/observe.js
View
9 observe/observe.js
@@ -654,7 +654,7 @@ steal('can/construct', function() {
* @inherits can.Observe
* @parent index
*
- * Provides the observable pattern for JavaScript arrays. It lets you:
+ * `new can.Observe.List([items])` provides the observable pattern for JavaScript arrays. It lets you:
*
* - change the structure of an array
* - listen to changes in the array
@@ -685,10 +685,11 @@ steal('can/construct', function() {
* list = new can.Observe.List(["a","b"])
* list.attr(1) //-> "b"
*
- * __WARNING:__ while using the index operator with [] is acceptable,
+ * __WARNING:__ while using the index operator with [] is possible,
* it should be noted that changing properties of objects that way
* will not call bound events to the observed list that would let
- * it know that an object in the list has changed.
+ * it know that an object in the list has changed. In almost every
+ * case you will use [can.Model.static.findAll findAll].
*
* Using the 'attr' method lets Observe know you accessed the
* property. This is used by [can.EJS] for live-binding.
@@ -776,7 +777,7 @@ steal('can/construct', function() {
* of items. For remove event, undefined.
* - `oldVal` - the old values at `attr`.
*
- * @constructor
+ * @constructor new
*
* @param {Array} [items...] the array of items to create the list with
*/
Please sign in to comment.
Something went wrong with that request. Please try again.