docs: add comment explaining handling of 409 conflict error (#577)

octokit · Nov 15, 2023 · 73f280d · 73f280d
1 parent 4d23d53
commit 73f280d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/iterator.ts b/src/iterator.ts
@@ -40,6 +40,8 @@ export function iterator(
 
           return { value: normalizedResponse };
         } catch (error: any) {
+          // `GET /repos/{owner}/{repo}/commits` throws a `409 Conflict` error for empty repositories
+          // See https://github.com/github/rest-api-description/issues/385
           if (error.status !== 409) throw error;
 
           url = "";