Comments

Author: DilumAluthge

.github/workflows/PrAssignee.yml

@@ -61,6 +61,23 @@ jobs:
               }
             }).catch((error) => {
               // TODO: add comments here.
+              //
+              // So, I'm not sure if the error is being thrown by `@octokit/request.js` or
+              // `@octokit/plugin-retry.js`. I suspect that the initial error is thrown by
+              // `request.js`, and is subsequently propagated by `plugin-retry.js`.
+              //
+              // Anyway, the docs for `request.js` say the following:
+              //
+              // > If an error occurs, the promise is rejected with an `error` object
+              //> containing 3 keys to help with debugging:
+              // >
+              // > - `error.status` The http response status code
+              // > - `error.request` The request options such as `method`, `url` and `data`
+              // > - `error.response` The http response object with `url`, `headers`, and `data`
+              //
+              // Source: https://github.com/octokit/request.js/blob/main/README.md#request
+              //
+              // So, inside this `.catch()`, we simply return that `error` object.
 
               return error;
             });