Merge pull request #992 from touilleMan/master

Add primary_key notice in defining-documents doc according to issue #985
MongoEngine · May 6, 2015 · c642eee · c642eee
2 parents 7f442f7 + 5f33d29
commit c642eee
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/guide/defining-documents.rst b/docs/guide/defining-documents.rst
@@ -146,6 +146,8 @@ arguments can be set on all fields:
     When True, use this field as a primary key for the collection.  `DictField`
     and `EmbeddedDocuments` both support being the primary key for a document.
 
+    .. note:: If set, this field is also accessible through the `pk` field.
+
 :attr:`choices` (Default: None)
     An iterable (e.g. a list or tuple) of choices to which the value of this
     field should be limited.