Skip to content

Commit 0b35dff

Browse files
committed
add to docstring
1 parent fed738d commit 0b35dff

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

pymongo/asynchronous/cursor.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -767,6 +767,8 @@ async def explain(self) -> _DocumentType:
767767
:meth:`~pymongo.asynchronous.database.AsyncDatabase.command` to run the explain
768768
command directly.
769769
770+
.. note:: The timeout of this method can be set using :func:`pymongo.timeout`.
771+
770772
.. seealso:: The MongoDB documentation on `explain <https://dochub.mongodb.org/core/explain>`_.
771773
"""
772774
c = self.clone()

pymongo/synchronous/cursor.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -765,6 +765,8 @@ def explain(self) -> _DocumentType:
765765
:meth:`~pymongo.database.Database.command` to run the explain
766766
command directly.
767767
768+
.. note:: The timeout of this method can be set using :func:`pymongo.timeout`.
769+
768770
.. seealso:: The MongoDB documentation on `explain <https://dochub.mongodb.org/core/explain>`_.
769771
"""
770772
c = self.clone()

0 commit comments

Comments
 (0)