disable genericTypes by default since it would often display redund…

…ant information when `variableTypes` is enabled
DetachHead · Oct 28, 2024 · 5766654 · 5766654
1 parent 9d258d7
commit 5766654
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/docs/configuration/language-server-settings.md b/docs/configuration/language-server-settings.md
@@ -48,7 +48,7 @@ the following settings are exclusive to basedpyright
 
 ![](inlayHints.functionReturnTypes.png)
 
-**basedpyright.analysis.inlayHints.genericTypes** [boolean]: Whether to show inlay hints on inferred generic types. (currently only works on `Final` and `ClassVar`):
+**basedpyright.analysis.inlayHints.genericTypes** [boolean]: Whether to show inlay hints on inferred generic types. Defaults to `false`:
 
 ![](inlayHints.genericTypes.png)
 

diff --git a/packages/pyright-internal/src/languageServerBase.ts b/packages/pyright-internal/src/languageServerBase.ts
@@ -1011,7 +1011,7 @@ export abstract class LanguageServerBase implements LanguageServerInterface, Dis
                 callArgumentNames: inlayHintSettings?.callArgumentNames ?? true,
                 functionReturnTypes: inlayHintSettings?.functionReturnTypes ?? true,
                 variableTypes: inlayHintSettings?.variableTypes ?? true,
-                genericTypes: inlayHintSettings?.genericTypes ?? true,
+                genericTypes: inlayHintSettings?.genericTypes ?? false,
             }).onInlayHints();
         }, token);
     }

diff --git a/packages/pyright-internal/src/realLanguageServer.ts b/packages/pyright-internal/src/realLanguageServer.ts
@@ -102,7 +102,12 @@ export abstract class RealLanguageServer extends LanguageServerBase {
             logLevel: LogLevel.Info,
             autoImportCompletions: true,
             functionSignatureDisplay: SignatureDisplayType.formatted,
-            inlayHints: { callArgumentNames: true, functionReturnTypes: true, variableTypes: true, genericTypes: true },
+            inlayHints: {
+                callArgumentNames: true,
+                functionReturnTypes: true,
+                variableTypes: true,
+                genericTypes: false,
+            },
         };
 
         try {

diff --git a/packages/vscode-pyright/package.json b/packages/vscode-pyright/package.json
@@ -1764,7 +1764,7 @@
                 },
                 "basedpyright.analysis.inlayHints.genericTypes": {
                     "type": "boolean",
-                    "default": true,
+                    "default": false,
                     "description": "Whether to show inlay hints on inferred generic types.",
                     "scope": "resource"
                 }