Improve wording.

jupyterlab · Feb 17, 2022 · 5cd6fe2 · 5cd6fe2
1 parent 2c4d19f
commit 5cd6fe2
Show file tree

Hide file tree

Showing 13 changed files with 41 additions and 47 deletions.
diff --git a/...st/jupyterlab/completer.test.ts-snapshots/completer-filter-jupyterlab-linux.png b/...st/jupyterlab/completer.test.ts-snapshots/completer-filter-jupyterlab-linux.png
diff --git a/galata/test/jupyterlab/completer.test.ts-snapshots/completer-jupyterlab-linux.png b/galata/test/jupyterlab/completer.test.ts-snapshots/completer-jupyterlab-linux.png
diff --git a/packages/completer-extension/schema/tracker.json b/packages/completer-extension/schema/tracker.json
@@ -5,8 +5,8 @@
   "jupyter.lab.transform": true,
   "properties": {
     "availableProviders": {
-      "title": "Installed completion providers.",
-      "description": "Configuration for installed completion providers, the keys of this dictionary are the identifiers of providers, the corresponding value is the priority rank of the provider. Providers with higher rank will be shown before the ones with lower rank, providers with negative rank are disabled.",
+      "title": "Completion providers rank setting.",
+      "description": "Providers with higher rank will be shown before the ones with lower rank, providers with negative rank are disabled.",
       "type": "object",
       "patternProperties": {
         "^.*$": {
@@ -25,15 +25,15 @@
       "type": "number",
       "default": 1000
     },
-    "showDocumentPanel": {
-      "title": "Show the document panel.",
-      "description": "Show or hide the document panel of completer widget, this configuration is applied to all providers. If a provider does not provide the document content, the panel will be hidden for this provider.",
+    "showDocumentationPanel": {
+      "title": "Show the documentation panel.",
+      "description": "Documentation panel setting.",
       "type": "boolean",
-      "default": true
+      "default": false
     },
-    "continuousHinting": {
-      "title": "Enable continuous hinting.",
-      "description": "Continuous hinting setting.",
+    "autoCompletion": {
+      "title": "Enable autocompletion.",
+      "description": "Autocompletion  setting.",
       "type": "boolean",
       "default": false
     }

diff --git a/packages/completer-extension/src/index.ts b/packages/completer-extension/src/index.ts
@@ -49,8 +49,8 @@ const manager: JupyterFrontEndPlugin<ICompletionProviderManager> = {
   ): ICompletionProviderManager => {
     const AVAILABLE_PROVIDERS = 'availableProviders';
     const PROVIDER_TIMEOUT = 'providerTimeout';
-    const SHOW_DOCUMENT_PANEL = 'showDocumentPanel';
-    const CONTINUOUS_HINTING = 'continuousHinting';
+    const SHOW_DOCUMENT_PANEL = 'showDocumentationPanel';
+    const CONTINUOUS_HINTING = 'autoCompletion';
     const manager = new CompletionProviderManager();
     const updateSetting = (
       settingValues: ISettingRegistry.ISettings,

diff --git a/packages/completer/src/connectorproxy.ts b/packages/completer/src/connectorproxy.ts
@@ -114,7 +114,7 @@ export class ConnectorProxy implements IConnectorProxy {
   private _context: ICompletionContext;
 
   /**
-   * Timeout for provider fetch request.
+   * Timeout for the fetch request.
    */
   private _timeout: number;
 

diff --git a/packages/completer/src/handler.ts b/packages/completer/src/handler.ts
@@ -97,12 +97,12 @@ export class CompletionHandler implements IDisposable {
   /**
    * Enable/disable continuous hinting mode.
    */
-  set continuousHinting(value: boolean) {
-    this._continuousHinting = value;
+  set autoCompletion(value: boolean) {
+    this._autoCompletion = value;
   }
 
-  get continuousHinting(): boolean {
-    return this._continuousHinting;
+  get autoCompletion(): boolean {
+    return this._autoCompletion;
   }
 
   /**
@@ -298,7 +298,7 @@ export class CompletionHandler implements IDisposable {
       return;
     }
     if (
-      this._continuousHinting &&
+      this._autoCompletion &&
       this._connector.shouldShowContinuousHint(
         this.completer.isVisible,
         changed
@@ -409,7 +409,7 @@ export class CompletionHandler implements IDisposable {
   private _editor: CodeEditor.IEditor | null | undefined = null;
   private _enabled = false;
   private _isDisposed = false;
-  private _continuousHinting = false;
+  private _autoCompletion = false;
 }
 
 /**

diff --git a/packages/completer/src/manager.ts b/packages/completer/src/manager.ts
@@ -49,8 +49,8 @@ export class CompletionProviderManager implements ICompletionProviderManager {
    * Enable/disable continuous hinting mode.
    */
   setContinuousHinting(value: boolean): void {
-    this._panelHandlers.forEach(handler => (handler.continuousHinting = value));
-    this._continuousHinting = value;
+    this._panelHandlers.forEach(handler => (handler.autoCompletion = value));
+    this._autoCompletion = value;
   }
 
   /**
@@ -117,7 +117,7 @@ export class CompletionProviderManager implements ICompletionProviderManager {
     } else {
       // Update existing handler.
       handler.completer.showDocsPanel = this._showDoc;
-      handler.continuousHinting = this._continuousHinting;
+      handler.autoCompletion = this._autoCompletion;
       if (editor) {
         handler.editor = editor;
         handler.connector = await this.generateConnectorProxy(
@@ -240,5 +240,5 @@ export class CompletionProviderManager implements ICompletionProviderManager {
   /**
    * Flag to enable/disable continuous hinting.
    */
-  private _continuousHinting: boolean;
+  private _autoCompletion: boolean;
 }
diff --git a/packages/completer/src/tokens.ts b/packages/completer/src/tokens.ts
@@ -81,7 +81,7 @@ export interface ICompletionProvider<
   ): Promise<T>;
 
   /**
-   * If users enable `continuousHinting` in setting, this method is
+   * If users enable `autoCompletion` in setting, this method is
    * called on text changed event of `CodeMirror` to check if the
    * completion items should be shown.
    *

diff --git a/packages/completer/style/base.css b/packages/completer/style/base.css
@@ -203,6 +203,7 @@
   0% {
     transform: translateX(0);
   }
+
   to {
     transform: translateX(400%);
   }

diff --git a/packages/console-extension/src/index.ts b/packages/console-extension/src/index.ts
@@ -198,7 +198,7 @@ const lineColStatus: JupyterFrontEndPlugin<void> = {
 };
 
 const completerPlugin: JupyterFrontEndPlugin<void> = {
-  id: '@jupyterlab/console-extensions:completer',
+  id: '@jupyterlab/console-extension:completer',
   requires: [IConsoleTracker],
   optional: [ICompletionProviderManager],
   activate: activateConsoleCompleterService,

diff --git a/packages/fileeditor-extension/src/index.ts b/packages/fileeditor-extension/src/index.ts
@@ -167,7 +167,7 @@ const lineColStatus: JupyterFrontEndPlugin<void> = {
 };
 
 const completerPlugin: JupyterFrontEndPlugin<void> = {
-  id: '@jupyterlab/fileeditor-extensions:completer',
+  id: '@jupyterlab/fileeditor-extension:completer',
   requires: [IEditorTracker],
   optional: [ICompletionProviderManager],
   activate: activateFileEditorCompleterService,

diff --git a/packages/notebook-extension/src/index.ts b/packages/notebook-extension/src/index.ts
@@ -756,7 +756,7 @@ const lineColStatus: JupyterFrontEndPlugin<void> = {
 };
 
 const completerPlugin: JupyterFrontEndPlugin<void> = {
-  id: '@jupyterlab/notebook-extensions:completer',
+  id: '@jupyterlab/notebook-extension:completer',
   requires: [INotebookTracker],
   optional: [ICompletionProviderManager],
   activate: activateNotebookCompleterService,

diff --git a/yarn.lock b/yarn.lock
@@ -2755,13 +2755,6 @@
   resolved "https://registry.yarnpkg.com/@types/json5/-/json5-0.0.30.tgz#44cb52f32a809734ca562e685c6473b5754a7818"
   integrity sha512-sqm9g7mHlPY/43fcSNrCYfOeX9zkTTK+euO5E6+CVijSMm5tTjkVdwdqRkY3ljjIAf8679vps5jKUoJBCLsMDA==
 
-"@types/lodash.curry@^4.1.6":
-  version "4.1.6"
-  resolved "https://registry.yarnpkg.com/@types/lodash.curry/-/lodash.curry-4.1.6.tgz#f26c490c80c92d7cbaa2300d542e89781d44b1ff"
-  integrity sha512-x3ctCcmOYqRrihNNnQJW6fe/yZFCgnrIa6p80AiPQRO8Jis29bBdy1dEw1FwngoF/mCZa3Bx+33fUZvOEE635Q==
-  dependencies:
-    "@types/lodash" "*"
-
 "@types/lodash.escape@^4.0.6":
   version "4.0.6"
   resolved "https://registry.yarnpkg.com/@types/lodash.escape/-/lodash.escape-4.0.6.tgz#71730c1a27bb5ac7f98f88d5e858fa4ad2df1106"
@@ -2822,7 +2815,7 @@
   resolved "https://registry.yarnpkg.com/@types/prettier/-/prettier-2.1.6.tgz#f4b1efa784e8db479cdb8b14403e2144b1e9ff03"
   integrity sha512-6gOkRe7OIioWAXfnO/2lFiv+SJichKVSys1mSsgyrYHSEjk8Ctv4tSR/Odvnu+HWlH2C8j53dahU03XmQdd5fA==
 
-"@types/prop-types@*", "@types/prop-types@^15.7.3":
+"@types/prop-types@*", "@types/prop-types@^15.7.4":
   version "15.7.4"
   resolved "https://registry.yarnpkg.com/@types/prop-types/-/prop-types-15.7.4.tgz#fcf7205c25dff795ee79af1e30da2c9790808f11"
   integrity sha512-rZ5drC/jWjrArrS8BR6SIr4cWpW09RNTYt9AMZo3Jwwif+iacXAqgVjm0B0Bv/S1jhDXKHqRVNCbACkJ89RAnQ==
@@ -4354,7 +4347,7 @@ collection-visit@^1.0.0:
     map-visit "^1.0.0"
     object-visit "^1.0.0"
 
-color-convert@^1.9.0, color-convert@^1.9.1:
+color-convert@^1.9.0, color-convert@^1.9.3:
   version "1.9.3"
   resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-1.9.3.tgz#bb71850690e1f136567de629d2d5471deda4c1e8"
   integrity sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==
@@ -4378,10 +4371,10 @@ color-name@^1.0.0, color-name@~1.1.4:
   resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2"
   integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==
 
-color-string@^1.5.4:
-  version "1.5.5"
-  resolved "https://registry.yarnpkg.com/color-string/-/color-string-1.5.5.tgz#65474a8f0e7439625f3d27a6a19d89fc45223014"
-  integrity sha512-jgIoum0OfQfq9Whcfc2z/VhCNcmQjWbey6qBX0vqt7YICflUmBCh9E9CiQD5GSJ+Uehixm3NUwHVhqUAWRivZg==
+color-string@^1.6.0:
+  version "1.9.0"
+  resolved "https://registry.yarnpkg.com/color-string/-/color-string-1.9.0.tgz#63b6ebd1bec11999d1df3a79a7569451ac2be8aa"
+  integrity sha512-9Mrz2AQLefkH1UvASKj6v6hj/7eWgjnT/cVsR8CumieLoT+g900exWeNogqtweI8dxloXN9BDQTYro1oWu/5CQ==
   dependencies:
     color-name "^1.0.0"
     simple-swizzle "^0.2.2"
@@ -4391,8 +4384,8 @@ color@^3.2.1:
   resolved "https://registry.yarnpkg.com/color/-/color-3.2.1.tgz#3544dc198caf4490c3ecc9a790b54fe9ff45e164"
   integrity sha512-aBl7dZI9ENN6fUGC7mWpMTPNHmWUSNan9tuWN6ahh5ZLNk9baLJOnSMlrQkHcrfFgz2/RigjUVAjdx36VcemKA==
   dependencies:
-    color-convert "^1.9.1"
-    color-string "^1.5.4"
+    color-convert "^1.9.3"
+    color-string "^1.6.0"
 
 colord@^2.9.2:
   version "2.9.2"
@@ -10885,10 +10878,10 @@ react-base16-styling@^0.9.1:
   dependencies:
     "@babel/runtime" "^7.16.7"
     "@types/base16" "^1.0.2"
-    "@types/lodash.curry" "^4.1.6"
+    "@types/lodash" "^4.14.178"
     base16 "^1.0.0"
-    color "^3.1.2"
-    csstype "^3.0.2"
+    color "^3.2.1"
+    csstype "^3.0.10"
     lodash.curry "^4.1.1"
 
 react-dom@^17.0.1:
@@ -11692,9 +11685,9 @@ simple-concat@^1.0.0:
   integrity sha512-cSFtAPtRhljv69IK0hTVZQ+OfE9nePi/rtJmw5UjHeVyVroEqJXP1sFztKUy1qU+xvz3u/sfYJLa947b7nAN2Q==
 
 simple-get@^3.0.3:
-  version "3.1.0"
-  resolved "https://registry.yarnpkg.com/simple-get/-/simple-get-3.1.0.tgz#b45be062435e50d159540b576202ceec40b9c6b3"
-  integrity sha512-bCR6cP+aTdScaQCnQKbPKtJOKDp/hj9EDLJo3Nw4y1QksqaovlW/bnptB6/c1e+qmNIDHRK+oXFDdEqBT8WzUA==
+  version "3.1.1"
+  resolved "https://registry.yarnpkg.com/simple-get/-/simple-get-3.1.1.tgz#cc7ba77cfbe761036fbfce3d021af25fc5584d55"
+  integrity sha512-CQ5LTKGfCpvE1K0n2us+kuMPbk/q0EKl82s4aheV9oXjFEz6W/Y7oQFVJuU6QG77hRT4Ghb5RURteF5vnWjupA==
   dependencies:
     decompress-response "^4.2.0"
     once "^1.3.1"