-
Type: Improvement
-
Resolution: Done
-
Priority: Minor - P4
-
Affects Version/s: None
-
Component/s: None
-
None
Documentation for SDAM monitoring is inadequate. A few problems that need to be fixed:
- Add ServerEventLogger, ServerHeartbeatLogger, and TopologyEventLogger examples to the top level monitoring documentation.
- Expose the documentation for parts of pymongo.ismaster.IsMaster, pymongo.server_description.ServerDescription, and pymongo.topology_description.TopologyDescription in built docs.
- Update the docstrings for ServerDescriptionChangedEvent, TopologyDescriptionChangedEvent, and ServerHeartbeatSucceededEvent to link to the docstrings for ServerDescription, TopologyDescription, and IsMaster respectively.
It might make sense to include the documentation for IsMaster, ServerDescription, and TopologyDescription on api/pymongo/monitoring.rst, rather than add the modules they come from to the toctree.
- related to
-
PYTHON-1117 TopologyDescription.has_readable_server and has_writable_server
- Closed
-
PYTHON-1142 Add TopologyDescription.topology_type_name and ServerDescription.server_type_name
- Closed
-
PYTHON-1137 Add public attribute for IsMaster._doc
- Closed