From 7afca2faa916eda848d1cf8e18e9873fa3dfc579 Mon Sep 17 00:00:00 2001 From: Bernie Hackett Date: Tue, 14 Jun 2016 11:32:24 -0700 Subject: [PATCH] PYTHON-1067 - Minor doc fixes --- doc/api/pymongo/monitoring.rst | 16 ++++++++++++++++ pymongo/monitoring.py | 6 +++--- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/doc/api/pymongo/monitoring.rst b/doc/api/pymongo/monitoring.rst index a230ed134..6216b1f1a 100644 --- a/doc/api/pymongo/monitoring.rst +++ b/doc/api/pymongo/monitoring.rst @@ -7,33 +7,49 @@ .. autofunction:: register(listener) .. autoclass:: CommandListener :members: + :inherited-members: .. autoclass:: ServerListener :members: + :inherited-members: .. autoclass:: ServerHeartbeatListener :members: + :inherited-members: .. autoclass:: TopologyListener :members: + :inherited-members: .. autoclass:: CommandStartedEvent :members: + :inherited-members: .. autoclass:: CommandSucceededEvent :members: + :inherited-members: .. autoclass:: CommandFailedEvent :members: + :inherited-members: .. autoclass:: ServerDescriptionChangedEvent :members: + :inherited-members: .. autoclass:: ServerOpeningEvent :members: + :inherited-members: .. autoclass:: ServerClosedEvent :members: + :inherited-members: .. autoclass:: TopologyDescriptionChangedEvent :members: + :inherited-members: .. autoclass:: TopologyOpenedEvent :members: + :inherited-members: .. autoclass:: TopologyClosedEvent :members: + :inherited-members: .. autoclass:: ServerHeartbeatStartedEvent :members: + :inherited-members: .. autoclass:: ServerHeartbeatSucceededEvent :members: + :inherited-members: .. autoclass:: ServerHeartbeatFailedEvent :members: + :inherited-members: diff --git a/pymongo/monitoring.py b/pymongo/monitoring.py index 75f4440b1..64b227617 100644 --- a/pymongo/monitoring.py +++ b/pymongo/monitoring.py @@ -154,7 +154,7 @@ class TopologyListener(_EventListener): """ raise NotImplementedError - def changed(self, event): + def description_changed(self, event): """Abstract method to handle a `TopologyDescriptionChangedEvent`. :Parameters: @@ -184,7 +184,7 @@ class ServerListener(_EventListener): """ raise NotImplementedError - def changed(self, event): + def description_changed(self, event): """Abstract method to handle a `ServerDescriptionChangedEvent`. :Parameters: @@ -225,7 +225,7 @@ def register(listener): """Register a global event listener. :Parameters: - - `listener`: A subclasses of :class:`CommandListener,` + - `listener`: A subclasses of :class:`CommandListener`, :class:`ServerHeartbeatListener`, :class:`ServerListener`, or :class:`TopologyListener`. """