fixing docstring (#15545)

Azure · Nov 25, 2020 · 2e25d43 · 2e25d43
1 parent 2154e14
commit 2e25d43
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/tools/azure-sdk-tools/devtools_testutils/azure_testcase.py b/tools/azure-sdk-tools/devtools_testutils/azure_testcase.py
@@ -295,7 +295,11 @@ def get_preparer_resource_name(self, prefix):
     @staticmethod
     def await_prepared_test(test_fn):
         """Synchronous wrapper for async test methods. Used to avoid making changes
-        upstream to AbstractPreparer (which doesn't await the functions it wraps)
+        upstream to AbstractPreparer, which only awaits async tests that use preparers.
+        (Add @AzureTestCase.await_prepared_test decorator to async tests without preparers)
+
+        # Note: this will only be needed so long as we maintain unittest.TestCase in our
+        test-class inheritance chain.
         """
 
         if sys.version_info < (3, 5):