chore: update JSdocs for detectUnlockedLevel

parvninama · parvninama · commit c9602cc17dfa · 2026-05-08T16:23:41.000+05:30
Signed-off-by: Parv Ninama &lt;ninamaparv@gmail.com&gt;
diff --git a/.github/scripts/shared/core/eligibility.js b/.github/scripts/shared/core/eligibility.js
@@ -160,13 +160,14 @@ function getNextLevelInfo(currentLevelKey) {
 }
 
 /**
- * Detects if the contributor just unlocked the next level.
+ * Detects whether the contributor appears to have just unlocked
+ * the next level based on current GitHub issue search results.
  *
  * Trigger condition:
- *   completed count === requiredCount
+ *   observed completed count === requiredCount
  *
  * Uses a capped query (requiredCount + 1) for efficiency.
- *
+ * 
  * @param {import('@actions/github').GitHub} github
  * @param {object} homeRepo
  * @param {string} username

Original file line number	Diff line number	Diff line change
`@@ -160,13 +160,14 @@ function getNextLevelInfo(currentLevelKey) {`
`160`	`160`	`}`
`161`	`161`
`162`	`162`	`/**`
`163`		`- * Detects if the contributor just unlocked the next level.`
	`163`	`+ * Detects whether the contributor appears to have just unlocked`
	`164`	`+ * the next level based on current GitHub issue search results.`
`164`	`165`	`*`
`165`	`166`	`* Trigger condition:`
`166`		`- * completed count === requiredCount`
	`167`	`+ * observed completed count === requiredCount`
`167`	`168`	`*`
`168`	`169`	`* Uses a capped query (requiredCount + 1) for efficiency.`
`169`		`- *`
	`170`	`+ *`
`170`	`171`	`* @param {import('@actions/github').GitHub} github`
`171`	`172`	`* @param {object} homeRepo`
`172`	`173`	`* @param {string} username`