From d78522f5e1e8523fae993c7d8648e0ea188dd1b0 Mon Sep 17 00:00:00 2001
From: Julien Fontanet <julien.fontanet@isonoe.net>
Date: Mon, 27 Apr 2015 12:14:30 +0200
Subject: [PATCH] Comment doc for Collection#getId().

---
 packages/xo-collection/src/collection.js | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/packages/xo-collection/src/collection.js b/packages/xo-collection/src/collection.js
index 16a574c7b..dc82f006a 100644
--- a/packages/xo-collection/src/collection.js
+++ b/packages/xo-collection/src/collection.js
@@ -57,8 +57,12 @@ export default class Collection extends EventEmitter {
     this._size = 0
   }
 
-  getKey (item) {
-    return item && item.id
+  // Overridable method used to compute the key of an item when
+  // unspecified.
+  //
+  // Default implementation returns the `id` property.
+  getKey (value) {
+    return value && value.id
   }
 
   // -----------------------------------------------------------------