Uploaded image for project: 'Python Driver'
  1. Python Driver
  2. PYTHON-1138

Improve documentation for SDAM monitoring

    • Type: Icon: Improvement Improvement
    • Resolution: Done
    • Priority: Icon: Minor - P4 Minor - P4
    • 3.4
    • Affects Version/s: None
    • Component/s: None
    • Labels:
      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.

            Assignee:
            bernie@mongodb.com Bernie Hackett
            Reporter:
            bernie@mongodb.com Bernie Hackett
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: