Merge pull request #1236 from AlexJerabek/AlexJ-Example

[API Documenter] Add extra newline character to example header
microsoft · Apr 16, 2019 · b5e8cd1 · b5e8cd1
2 parents 9840498 + b55bf4c
commit b5e8cd1
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/apps/api-documenter/src/documenters/OfficeYamlDocumenter.ts b/apps/api-documenter/src/documenters/OfficeYamlDocumenter.ts
@@ -133,7 +133,7 @@ export class OfficeYamlDocumenter extends YamlDocumenter {
   }
 
   private _generateExampleSnippetText(snippets: string[]): string {
-    const text: string[] = ['\n#### Examples\n'];
+    const text: string[] = ['\n\n#### Examples\n'];
     for (const snippet of snippets) {
       if (snippet.search(/await/) === -1) {
         text.push('```javascript');

diff --git a/common/changes/@microsoft/api-documenter/AlexJ-Example_2019-04-16-00-12.json b/common/changes/@microsoft/api-documenter/AlexJ-Example_2019-04-16-00-12.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/api-documenter",
+      "comment": "Adding an extra newline to the OfficeYamlDocumenter Examples header insertion",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft/api-documenter",
+  "email": "[email protected]"
+}