소스 검색

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 {
     /**