Merge pull request #1973 from greg0ire/document_mapped

weaverryan · weaverryan · commit 9e2363d7782d · 2012-11-27T19:16:09.000-08:00
Document the mapped form type option
diff --git a/reference/forms/types/form.rst b/reference/forms/types/form.rst
@@ -19,8 +19,10 @@ on all fields.
 
 .. include:: /reference/forms/types/options/trim.rst.inc
 
+.. include:: /reference/forms/types/options/mapped.rst.inc
+
 .. include:: /reference/forms/types/options/property_path.rst.inc
 
 .. include:: /reference/forms/types/options/attr.rst.inc
 
-.. include:: /reference/forms/types/options/translation_domain.rst.inc
+.. include:: /reference/forms/types/options/translation_domain.rst.inc
diff --git a/reference/forms/types/options/mapped.rst.inc b/reference/forms/types/options/mapped.rst.inc
@@ -0,0 +1,7 @@
+mapped
+~~~~~~
+
+**type**: ``boolean``
+
+If you wish the field to be ignored when reading or writing to the object, you
+can set the ``mapped`` option to ``false``
diff --git a/reference/forms/types/options/property_path.rst.inc b/reference/forms/types/options/property_path.rst.inc
@@ -11,4 +11,9 @@ you can set the ``property_path`` option. Its default value is the field's
 name.
 
 If you wish the field to be ignored when reading or writing to the object 
-you can set the ``property_path`` option to ``false``
+you can set the ``property_path`` option to ``false``, but using
+``property_path`` for this purpose is deprecated, you should do it the way
+described below:
+
+.. versionadded:: 2.1
+    Since 2.1, the ``mapped`` option has been added for this use-case.
