[api-documenter] mardown: fixes newline in table code blocks

Rudolf Meijering · Rudolf Meijering · commit 2249300549e5 · 2019-04-15T14:07:48.000+02:00
diff --git a/apps/api-documenter/src/markdown/MarkdownEmitter.ts b/apps/api-documenter/src/markdown/MarkdownEmitter.ts
@@ -115,7 +115,7 @@ export class MarkdownEmitter {
         if (context.insideTable) {
           const code: string = this.getTableEscapedText(docCodeSpan.code);
           const parts: string[] = code.split(/\r?\n/g);
-          writer.write(parts.join('`<p/>`'));
+          writer.write(parts.join('</code><br/><code>'));
         } else {
           writer.write(docCodeSpan.code);
         }
diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json
@@ -990,6 +990,51 @@
           "releaseTag": "Public",
           "name": "IDocInterface4",
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "Context",
+              "docComment": "/**\n * Test newline rendering when code blocks are used in tables\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Reference",
+                  "text": "Context"
+                },
+                {
+                  "kind": "Content",
+                  "text": ": "
+                },
+                {
+                  "kind": "Content",
+                  "text": "({ "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "children"
+                },
+                {
+                  "kind": "Content",
+                  "text": " }: {\n        "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "children"
+                },
+                {
+                  "kind": "Content",
+                  "text": ": string;\n    }) => boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "releaseTag": "Public",
+              "name": "Context",
+              "propertyTypeTokenRange": {
+                "startIndex": 2,
+                "endIndex": 7
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "generic",
diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.md b/build-tests/api-documenter-test/etc/api-documenter-test.api.md
@@ -66,6 +66,9 @@ export interface IDocInterface3 {
 
 // @public
 export interface IDocInterface4 {
+    Context: ({ children }: {
+        children: string;
+    }) => boolean;
     generic: Generic<number>;
     numberOrFunction: number | (() => number);
     stringOrNumber: string | number;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.context.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.context.md
@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [IDocInterface4](./api-documenter-test.idocinterface4.md) &gt; [Context](./api-documenter-test.idocinterface4.context.md)
+
+## IDocInterface4.Context property
+
+Test newline rendering when code blocks are used in tables
+
+<b>Signature:</b>
+
+```typescript
+Context: ({ children }: {
+        children: string;
+    }) => boolean;
+```
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.md
@@ -16,6 +16,7 @@ export interface IDocInterface4
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [Context](./api-documenter-test.idocinterface4.context.md) | <code>({ children }: {</code><br/><code>        children: string;</code><br/><code>    }) =&gt; boolean</code> | Test newline rendering when code blocks are used in tables |
 |  [generic](./api-documenter-test.idocinterface4.generic.md) | <code>Generic&lt;number&gt;</code> | make sure html entities are escaped in tables. |
 |  [numberOrFunction](./api-documenter-test.idocinterface4.numberorfunction.md) | <code>number &#124; (() =&gt; number)</code> | a union type with a function |
 |  [stringOrNumber](./api-documenter-test.idocinterface4.stringornumber.md) | <code>string &#124; number</code> | a union type |
diff --git a/build-tests/api-documenter-test/etc/yaml/api-documenter-test/idocinterface4.yml b/build-tests/api-documenter-test/etc/yaml/api-documenter-test/idocinterface4.yml
@@ -9,9 +9,28 @@ items:
     type: interface
     package: api-documenter-test
     children:
+      - api-documenter-test.IDocInterface4.Context
       - api-documenter-test.IDocInterface4.generic
       - api-documenter-test.IDocInterface4.numberOrFunction
       - api-documenter-test.IDocInterface4.stringOrNumber
+  - uid: api-documenter-test.IDocInterface4.Context
+    summary: Test newline rendering when code blocks are used in tables
+    name: Context
+    fullName: Context
+    langs:
+      - typeScript
+    type: property
+    syntax:
+      content: |-
+        Context: ({ children }: {
+                children: string;
+            }) => boolean;
+      return:
+        type:
+          - |-
+            ({ children }: {
+                    children: string;
+                }) => boolean
   - uid: api-documenter-test.IDocInterface4.generic
     summary: make sure html entities are escaped in tables.
     name: generic
diff --git a/build-tests/api-documenter-test/src/DocClass1.ts b/build-tests/api-documenter-test/src/DocClass1.ts
@@ -86,6 +86,10 @@ export interface IDocInterface4 {
    * make sure html entities are escaped in tables.
    */
   generic: Generic<number>;
+  /**
+   * Test newline rendering when code blocks are used in tables
+   */
+  Context: ({ children }: { children: string }) => boolean;
 }
 
 /**
diff --git a/common/changes/@microsoft/api-documenter/fix-newline-in-table-code-block_2019-04-15-10-59.json b/common/changes/@microsoft/api-documenter/fix-newline-in-table-code-block_2019-04-15-10-59.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/api-documenter",
+      "comment": "Fixes newline rendering when code blocks are used in tables",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft/api-documenter",
+  "email": "skaapgif@users.noreply.github.com"
+}

Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ export class MarkdownEmitter {`
`115`	`115`	`if (context.insideTable) {`
`116`	`116`	`const code: string = this.getTableEscapedText(docCodeSpan.code);`
`117`	`117`	`const parts: string[] = code.split(/\r?\n/g);`
`118`		- writer.write(parts.join('`<p/>`'));
	`118`	`+ writer.write(parts.join('</code><br/><code>'));`
`119`	`119`	`} else {`
`120`	`120`	`writer.write(docCodeSpan.code);`
`121`	`121`	`}`