Documented that it is possible to specify a name when using a dict to define an index

2018-08-30 23:13:10 +02:00
parent 60fe919992
commit bd524d2e1e
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`.