docstr

Author: Will-ShaoHua

packages/amazonq/src/app/inline/recommendationService.ts

@@ -122,13 +122,18 @@ export class RecommendationService {
             })
             const t0 = performance.now()
 
-            // yield event loop to let the document listen catch updates
+            // Yield event loop to let the document listen catch updates
             await sleep(1)
-            // prevent user deletion invoking auto trigger
-            // this is a best effort estimate of deletion
+            // Best effort estimate of deletion
             const isTriggerByDeletion = documentEventListener.isLastEventDeletion(document.uri.fsPath)
 
             const ps: Promise<InlineCompletionListWithReferences>[] = []
+            /**
+             * IsTriggerByDeletion is to prevent user deletion invoking Completions.
+             * PartialResultToken is not a hack for now since only Edits suggestion use partialResultToken across different calls of [getAllRecommendations],
+             * Completions use PartialResultToken with single 1 call of [getAllRecommendations].
+             * Edits leverage partialResultToken to achieve EditStreak such that clients can pull all continuous suggestions generated by the model within 1 EOS block.
+             */
             if (!isTriggerByDeletion && !request.partialResultToken) {
                 const completionPromise: Promise<InlineCompletionListWithReferences> = languageClient.sendRequest(
                     inlineCompletionWithReferencesRequestType.method,