fix: Improve type params table readability

typedoc2md · Jun 23, 2021 · 52038e2 · 52038e2
1 parent 1b3395f
commit 52038e2
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/packages/typedoc-plugin-markdown/src/resources/helpers/type-parameter-table.ts b/packages/typedoc-plugin-markdown/src/resources/helpers/type-parameter-table.ts
@@ -32,12 +32,15 @@ function table(parameters: any) {
     row.push(`\`${parameter.name}\``);
 
     if (showTypeCol) {
-      const typeCol: string[] = [`\`${parameter.name}\``];
+      const typeCol: string[] = [];
+      if (!parameter.type && !parameter.default) {
+        typeCol.push(`\`${parameter.name}\``);
+      }
       if (parameter.type) {
-        typeCol.push(`: ${type.call(parameter.type, 'object')}`);
+        typeCol.push(`extends ${type.call(parameter.type, 'object')}`);
       }
       if (parameter.default) {
-        typeCol.push(` = ${type.call(parameter.default)}`);
+        typeCol.push(type.call(parameter.default));
       }
       row.push(typeCol.join(''));
     }

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/declarations.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/declarations.spec.ts.snap
@@ -28,7 +28,7 @@ exports[`Declarations: should compile any function type 1`] = `
 
 | Name | Type |
 | :------ | :------ |
-| \`A\` | \`A\` = \`any\` |
+| \`A\` | \`any\` |
 
 #### Type declaration
 

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/generics.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/generics.spec.ts.snap
@@ -46,9 +46,9 @@ exports[`Generics: should compile function with complex type params' 1`] = `
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| \`A\` | \`A\`: [\`ClassWithTypeParams\`](classwithtypeparams.md)<\`string\`, \`number\`, \`A\`\\\\> | Comment for type \`A\` |
-| \`B\` | \`B\` = \`string\` \\\\| \`boolean\` | Comment for type \`B\` |
-| \`C\` | \`C\` = \`string\` | - |
+| \`A\` | extends [\`ClassWithTypeParams\`](classwithtypeparams.md)<\`string\`, \`number\`, \`A\`\\\\> | Comment for type \`A\` |
+| \`B\` | \`string\` \\\\| \`boolean\` | Comment for type \`B\` |
+| \`C\` | \`string\` | - |
 
 ##### Returns