Update build-tools/packages/build-cli/src/library/githubRest.ts

Co-authored-by: Tyler Butler <tyler@tylerbutler.com>
microsoft · Oct 3, 2024 · 9e4a477 · 9e4a477
1 parent bb44922
commit 9e4a477
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/build-tools/packages/build-cli/src/library/githubRest.ts b/build-tools/packages/build-cli/src/library/githubRest.ts
@@ -112,7 +112,7 @@ export async function isPrApprovedByUsers(
 }
 
 /**
- * Create or Update(If already exists based on commentIdentifier) a review comment on a PR.
+ * Creates or modifies a single review comment on a PR. The comment is identified with a unique identifier, so the same comment is updated on repeated calls.
  *
  * @param github - Details about the GitHub repo and auth to use.
  * @param prNumber - Pull request number.