docs; clarify error returned by unique indexes

relates to #1225
Automattic · Dec 6, 2012 · 8456daf · 8456daf
1 parent f25c7c2
commit 8456daf
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/lib/schematype.js b/lib/schematype.js
@@ -123,11 +123,13 @@ SchemaType.prototype.index = function (options) {
 /**
  * Declares an unique index.
  *
- * ####Examples:
+ * ####Example:
  *
  *     var s = new Schema({ name: { type: String, unique: true })
  *     Schema.path('name').index({ unique: true });
  *
+ * _NOTE: violating the constraint returns an `E11000` error from MongoDB when saving, not a Mongoose validation error._
+ *
  * @param {Boolean} bool
  * @return {SchemaType} this
  * @api public
@@ -145,7 +147,7 @@ SchemaType.prototype.unique = function (bool) {
 /**
  * Declares a sparse index.
  *
- * ####Examples:
+ * ####Example:
  *
  *     var s = new Schema({ name: { type: String, sparse: true })
  *     Schema.path('name').index({ sparse: true });