Merge pull request #1862 from bagerard/document_name_param_for_indexes

Documented that it is possible to specify a 'name' for the indexes (using the dict definition)
2018-09-03 17:20:17 +08:00
parent 14e9c58444 bd524d2e1e
commit 5a091956ef
2 changed files with 4 additions and 1 deletions
--- a/docs/guide/defining-documents.rst
+++ b/docs/guide/defining-documents.rst
@@ -513,6 +513,9 @@ If a dictionary is passed then the following options are available:
    Allows you to automatically expire data from a collection by setting the
    time in seconds to expire the a field.

+:attr:`name` (Optional)
+    Allows you to specify a name for the index
+
 .. note::

    Inheritance adds extra fields indices see: :ref:`document-inheritance`.