Add contributor docs for the delay function

XMLWordPrintableJSON

    • Type: Improvement
    • Resolution: Fixed
    • Priority: Unknown
    • 4.16.0
    • Affects Version/s: None
    • Component/s: Tests
    • 🔵 Done
    • Python Drivers
    • Not Needed
    • None
    • None
    • None
    • None
    • None
    • None

      Context

      We have a delay() utility function that we use in testing to trigger a long-running operation on the server.
      We should do the following to make it more discoverable and easy to use:

      • Add a docstring with an example, calling out that you need to add a document to the collection or the server may decide not to sleep at all.
      • Add a note in the contributing guide pointing out the function's existence and when you might want to use it.

      Definition of done

      Update the docstring and the contributing guide.

      Pitfalls

      None

            Assignee:
            Casey Clements
            Reporter:
            Steve Silvester
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: