docs: update syncLabel JSDoc to match revised early-return logic

darshit2308 · darshit2308 · commit 06fdf32d9fb8 · 2026-05-06T11:11:34.000+05:30
Signed-off-by: darshit2308 &lt;darshit2308@gmail.com&gt;
diff --git a/.github/scripts/review-sync/labels.js b/.github/scripts/review-sync/labels.js
@@ -177,12 +177,14 @@ function determineLabel(approvals) {
  * Sync the queue label on a single PR.
  *
  * Order of operations (non-negotiable):
- *   1. Check if the correct label is already present → skip if yes
- *   2. ADD the correct label first
- *   3. THEN remove any stale queue labels
+ *   1. Compute stale queue labels on the PR
+ *   2. Skip only if correct label is already present AND no stale labels exist
+ *   3. ADD the correct label first
+ *   4. THEN remove any stale queue labels
  *
  * This ensures a PR never has zero queue labels, even if the process
- * crashes mid-run.
+ * crashes mid-run. Stale labels are always cleaned up, even when the
+ * correct label was already present.
  *
  * @param {object}  github - Octokit instance
  * @param {string}  owner  - Repository owner

Original file line number	Diff line number	Diff line change
`@@ -177,12 +177,14 @@ function determineLabel(approvals) {`
`177`	`177`	`* Sync the queue label on a single PR.`
`178`	`178`	`*`
`179`	`179`	`* Order of operations (non-negotiable):`
`180`		`- * 1. Check if the correct label is already present → skip if yes`
`181`		`- * 2. ADD the correct label first`
`182`		`- * 3. THEN remove any stale queue labels`
	`180`	`+ * 1. Compute stale queue labels on the PR`
	`181`	`+ * 2. Skip only if correct label is already present AND no stale labels exist`
	`182`	`+ * 3. ADD the correct label first`
	`183`	`+ * 4. THEN remove any stale queue labels`
`183`	`184`	`*`
`184`	`185`	`* This ensures a PR never has zero queue labels, even if the process`
`185`		`- * crashes mid-run.`
	`186`	`+ * crashes mid-run. Stale labels are always cleaned up, even when the`
	`187`	`+ * correct label was already present.`
`186`	`188`	`*`
`187`	`189`	`* @param {object} github - Octokit instance`
`188`	`190`	`* @param {string} owner - Repository owner`