added a better comment for the remove method

ianstormtaylor · ianstormtaylor · commit c45282a071a7 · 2013-06-02T21:11:48.000-07:00
diff --git a/index.js b/index.js
@@ -74,7 +74,8 @@ Collection.prototype.push = function(model){
 };
 
 /**
- * Remove `model` from the collection.
+ * Remove `model` from the collection, returning `true` when present,
+ * otherwise `false`.
  *
  * @param {Object} model
  * @api public

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,8 @@ Collection.prototype.push = function(model){`
`74`	`74`	`};`
`75`	`75`
`76`	`76`	`/**`
`77`		- * Remove `model` from the collection.
	`77`	+ * Remove `model` from the collection, returning `true` when present,
	`78`	+ * otherwise `false`.
`78`	`79`	`*`
`79`	`80`	`* @param {Object} model`
`80`	`81`	`* @api public`