From fc39fd75193d2ba11811409217e0e1b2d25447a8 Mon Sep 17 00:00:00 2001 From: Emmanuel Leblond Date: Wed, 6 May 2015 18:30:49 +0200 Subject: [PATCH] Update defining-documents.rst Add primary_key notice according to issue #985 --- docs/guide/defining-documents.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/guide/defining-documents.rst b/docs/guide/defining-documents.rst index 6f249535..274f0f43 100644 --- 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 throught 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.