docs(linter/plugins): improve documentation for firstCommentAtOrAfter (#27538)

Comments-only-update. Follow-on after #27393.

That PR introduced a function `firstCommentAtOrAfter`. Improve the JSDoc comment for it.
This commit is contained in:
overlookmotel committed 2026-10-10 12:19:11 +00:00
1 parent 924b9a6421
commit 98cc2b4beb
1 file changed
+9 -1
@@ -229,7 +229,15 @@ export function commentsExistBetween(
);
}
/** Find the first comment whose `start` is at or after `offset`. */
/**
* Find the first comment whose `start` is at or after `offset`.
*
* Searched range starts at `startIndex` and ends at `length`.
* Returns `length` if all comments have `start` < `offset`.
*
* Note: Source text is limited to 1 GiB max, so number of comments cannot exceed 2^30.
* This makes it safe to use `>> 1` for division by 2 below (which is faster than `>>> 1`).
*/
function firstCommentAtOrAfter(
int32: Int32Array,
offset: number,