瀏覽代碼

Add docstring with more context for refactor

Edward Zhao 5 年之前
父節點
當前提交
ad1aac8be8
共有 1 個文件被更改,包括 7 次插入1 次删除
  1. 7 1
      packages/completer/src/handler.ts

+ 7 - 1
packages/completer/src/handler.ts

@@ -494,7 +494,13 @@ export namespace CompletionHandler {
   export type ICompletionItems = ReadonlyArray<ICompletionItem>;
 
   /**
-   * Completion item object based off of LSP CompletionItem
+   * Completion item object based off of LSP CompletionItem.
+   * Compared to the old kernel completions interface, this enhances the completions UI to support:
+   * - differentiation between inserted text and user facing text
+   * - documentation for each completion item to be displayed adjacently
+   * - deprecation styling
+   * - custom icons
+   * and other potential new features.
    */
   export interface ICompletionItem extends PartialJSONObject {
     /**