PYTHON-1067 - Minor doc fixes
This commit is contained in:
parent
d5082fe45c
commit
7afca2faa9
@ -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:
|
||||
|
||||
@ -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`.
|
||||
"""
|
||||
|
||||
Loading…
Reference in New Issue
Block a user