Merge pull request #22584 from civicrm/5.46

[civicrm-core.git] / Civi / Test / GuzzleTestTrait.php

diff --git a/Civi/Test/GuzzleTestTrait.php b/Civi/Test/GuzzleTestTrait.php
index c372d3eee9e6ac4794b95e276bd6c2736c90310e..c65e029dd76ab356d9afbebefc550624e1e3f251 100644 (file)
--- a/Civi/Test/GuzzleTestTrait.php
+++ b/Civi/Test/GuzzleTestTrait.php
@@ -11,7 +11,11 @@ use GuzzleHttp\Client;
 /**
  * Class GuzzleTestTrait
  *
- * This trait defines a number of helper functions for testing guzzle.
+ * This trait defines a number of helper functions for testing Guzzle-based logic,
+ * such as a payment-processing gateway.
+ *
+ * Use this in a headless test for which you need to mock outbound HTTP requests from Civi.
+ * Alternatively, to write an E2E test with inbound HTTP requests to Civi, see HttpTestTrait.
  */
 trait GuzzleTestTrait {
   /**