Link to createIndexes command from create_indexes documentation.

Fix markup for Collation class in IndexModel documentation.
This commit is contained in:
Luke Lovett 2017-03-03 14:43:34 -08:00
parent 0373c3d9f7
commit 73770db06f
2 changed files with 5 additions and 3 deletions

View File

@ -1367,7 +1367,7 @@ class Collection(common.BaseObject):
- `indexes`: A list of :class:`~pymongo.operations.IndexModel`
instances.
.. note:: `create_indexes` uses the ``createIndexes`` command
.. note:: `create_indexes` uses the `createIndexes`_ command
introduced in MongoDB **2.6** and cannot be used with earlier
versions.
@ -1379,6 +1379,8 @@ class Collection(common.BaseObject):
Apply this collection's write concern automatically to this operation
when connected to MongoDB >= 3.4.
.. versionadded:: 3.0
.. _createIndexes: https://docs.mongodb.com/manual/reference/command/createIndexes/
"""
if not isinstance(indexes, list):
raise TypeError("indexes must be a list")

View File

@ -225,8 +225,8 @@ class IndexModel(object):
be a UTC datetime or the data will not expire.
- `partialFilterExpression`: A document that specifies a filter for
a partial index.
- `collation`: An instance of `~pymongo.collation.Collation` that
specifies the collation to use in MongoDB >= 3.4.
- `collation`: An instance of :class:`~pymongo.collation.Collation`
that specifies the collation to use in MongoDB >= 3.4.
See the MongoDB documentation for a full list of supported options by
server version.