From 43dabb28251a2740dc1c5366ddf659e52dfb3ef6 Mon Sep 17 00:00:00 2001 From: BenCotte Date: Tue, 11 Oct 2016 18:14:17 +0200 Subject: [PATCH 1/2] Dictionnary Field recommended use At Dictionary Fields description, it seems that the intent of the sentence make more sense by adding : "not". --- docs/guide/defining-documents.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/defining-documents.rst b/docs/guide/defining-documents.rst index 6ac88f01..d276b041 100644 --- a/docs/guide/defining-documents.rst +++ b/docs/guide/defining-documents.rst @@ -215,7 +215,7 @@ document class as the first argument:: Dictionary Fields ----------------- Often, an embedded document may be used instead of a dictionary -- generally -this is recommended as dictionaries don't support validation or custom field +this is not recommended as dictionaries don't support validation or custom field types. However, sometimes you will not know the structure of what you want to store; in this situation a :class:`~mongoengine.fields.DictField` is appropriate:: From d8dd07d9efb4a98f941736dd90b77d838ea676bc Mon Sep 17 00:00:00 2001 From: BenCotte Date: Sun, 20 Nov 2016 11:19:36 +0100 Subject: [PATCH 2/2] Updating Dict Fields use description Update dict fields use misleading description to clarify use case. --- docs/guide/defining-documents.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/guide/defining-documents.rst b/docs/guide/defining-documents.rst index d276b041..f59f856e 100644 --- a/docs/guide/defining-documents.rst +++ b/docs/guide/defining-documents.rst @@ -214,9 +214,9 @@ document class as the first argument:: Dictionary Fields ----------------- -Often, an embedded document may be used instead of a dictionary -- generally -this is not recommended as dictionaries don't support validation or custom field -types. However, sometimes you will not know the structure of what you want to +Often, an embedded document may be used instead of a dictionary – generally +embedded documents are recommended as dictionaries don’t support validation +or custom field types. However, sometimes you will not know the structure of what you want to store; in this situation a :class:`~mongoengine.fields.DictField` is appropriate:: class SurveyResponse(Document):