Use example tag in JSDoc (#13745)

WordPress · Mar 6, 2019 · 978e8f7 · 978e8f7
1 parent d043910
commit 978e8f7
Showing 1 changed file with 18 additions and 14 deletions.
diff --git a/packages/e2e-test-utils/src/mocks/set-up-response-mocking.js b/packages/e2e-test-utils/src/mocks/set-up-response-mocking.js
@@ -10,21 +10,25 @@ let requestMocks = [];
 
 /**
  * Sets up mock checks and responses. Accepts a list of mock settings with the following properties:
- *   - match: function to check if a request should be mocked.
- *   - onRequestMatch: async function to respond to the request.
  *
- * Example:
- *   const MOCK_RESPONSES = [
- *     {
- *       match: isEmbedding( 'https://wordpress.org/gutenberg/handbook/' ),
- *       onRequestMatch: JSONResponse( MOCK_BAD_WORDPRESS_RESPONSE ),
- *     },
- *     {
- *       match: isEmbedding( 'https://wordpress.org/gutenberg/handbook/block-api/attributes/' ),
- *       onRequestMatch: JSONResponse( MOCK_EMBED_WORDPRESS_SUCCESS_RESPONSE ),
- *     }
- *  ];
- *  setUpResponseMocking( MOCK_RESPONSES );
+ * - `match`: function to check if a request should be mocked.
+ * - `onRequestMatch`: async function to respond to the request.
+ *
+ * @example
+ *
+ * ```js
+ * const MOCK_RESPONSES = [
+ *   {
+ *     match: isEmbedding( 'https://wordpress.org/gutenberg/handbook/' ),
+ *     onRequestMatch: JSONResponse( MOCK_BAD_WORDPRESS_RESPONSE ),
+ *   },
+ *   {
+ *     match: isEmbedding( 'https://wordpress.org/gutenberg/handbook/block-api/attributes/' ),
+ *     onRequestMatch: JSONResponse( MOCK_EMBED_WORDPRESS_SUCCESS_RESPONSE ),
+ *   }
+ * ];
+ * setUpResponseMocking( MOCK_RESPONSES );
+ * ```
  *
  * If none of the mock settings match the request, the request is allowed to continue.
  *