Update documentation and some inline comments

Author: mikoarce

API_DOCS.md

@@ -188,6 +188,7 @@ Describes the shape and behaviour of the resources object you will pass to `getL
 | `isBatchKeyASet`         | (Optional) Set to true if the interface of the resource takes the batch key as a set (rather than an array). For example, when using a generated clientlib based on swagger where `uniqueItems: true` is set for the batchKey parameter. Default: false. |
 | `propertyBatchKey`       | (Optional) The argument to the resource that represents the optional properties we want to fetch. (e.g. usually 'properties' or 'features').                                                                                                             |
 | `responseKey`            | (Non-optional when propertyBatchKey is used) The key in the response objects corresponds to `batchKey`. This should be the only field that are marked as required in your swagger endpoint response, except nestedPath.                                  |
+| `maxBatchSize`           | (Optional) Limits the number of items that can be batched together in a single request. When more items are requested than this limit, multiple requests will be made. This can help prevent hitting URI length limits or timeouts for large batches. |
 
 ### `typings`
 

__tests__/implementation.test.js

@@ -1279,7 +1279,7 @@ test('batch endpoint with maxBatchSize', async () => {
     await createDataLoaders(config, async (getLoaders) => {
         const loaders = getLoaders(resources);
 
-        // Request 5 items at once, which should be split into 3 batches (2 + 2 + 1)
+        // Request 5 items at once, which should be split by maxBatchSize later in the test.
         const results = await Promise.all([
             loaders.foo.load({ foo_id: 1, properties: ['name', 'rating'] }),
             loaders.foo.load({ foo_id: 2, properties: ['name', 'rating'] }),
@@ -1298,7 +1298,6 @@ test('batch endpoint with maxBatchSize', async () => {
         ]);
 
         // Verify that the requests were batched correctly
-        // We should have 3 batches with max 2 IDs.
         expect(receivedBatches.map(batch => batch.length)).toEqual([3, 2]);
 
         // Verify that all IDs were requested
@@ -1341,7 +1340,7 @@ test('batch endpoint with propertyBatchKey and maxBatchSize', async () => {
     await createDataLoaders(config, async (getLoaders) => {
         const loaders = getLoaders(resources);
 
-        // Request 5 items at once, which should be split into 3 batches (2 + 2 + 1)
+        // Request 5 items at once, which should be split by maxBatchSize later in the test.
         const results = await Promise.all([
             loaders.foo.load({ foo_id: 1, properties: ['name', 'rating'] }),
             loaders.foo.load({ foo_id: 2, properties: ['name', 'rating'] }),
@@ -1360,7 +1359,6 @@ test('batch endpoint with propertyBatchKey and maxBatchSize', async () => {
         ]);
 
         // Verify that the requests were batched correctly
-        // We should have 3 batches with max 2 IDs.
         expect(receivedBatches.map(batch => batch.length)).toEqual([2, 2, 1]);
 
         // Verify that all IDs were requested