From 67dc970ce45f2867afefac6298f84c8140ad2c81 Mon Sep 17 00:00:00 2001 From: Peter Bacon Darwin Date: Wed, 10 May 2017 11:00:02 +0100 Subject: [PATCH] docs(common): remove h1s from API docs Only one h1 is allowed per document, and this is provided by the template. So we cannot have any h1 tags (or `#` markdown shorthand) in any API docs. Closes #16193 --- packages/common/src/directives/ng_component_outlet.ts | 2 +- packages/common/src/directives/ng_if.ts | 8 ++++---- packages/common/src/directives/ng_template_outlet.ts | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/common/src/directives/ng_component_outlet.ts b/packages/common/src/directives/ng_component_outlet.ts index c43848932e..34e32c8e71 100644 --- a/packages/common/src/directives/ng_component_outlet.ts +++ b/packages/common/src/directives/ng_component_outlet.ts @@ -49,7 +49,7 @@ import {ComponentFactoryResolver, ComponentRef, Directive, Injector, Input, NgMo * ngModuleFactory: moduleFactory;"> * * ``` - * # Example + * ## Example * * {@example common/ngComponentOutlet/ts/module.ts region='SimpleExample'} * diff --git a/packages/common/src/directives/ng_if.ts b/packages/common/src/directives/ng_if.ts index 5e71d31d1f..122d046d87 100644 --- a/packages/common/src/directives/ng_if.ts +++ b/packages/common/src/directives/ng_if.ts @@ -17,13 +17,13 @@ import {Directive, EmbeddedViewRef, Input, TemplateRef, ViewContainerRef} from ' * - `then` template is the inline template of `ngIf` unless bound to a different value. * - `else` template is blank unless it is bound. * - * # Most common usage + * ## Most common usage * * The most common usage of the `ngIf` directive is to conditionally show the inline template as * seen in this example: * {@example common/ngIf/ts/module.ts region='NgIfSimple'} * - * # Showing an alternative template using `else` + * ## Showing an alternative template using `else` * * If it is necessary to display a template when the `expression` is falsy use the `else` template * binding as shown. Note that the `else` binding points to a `` labeled `#elseBlock`. @@ -32,7 +32,7 @@ import {Directive, EmbeddedViewRef, Input, TemplateRef, ViewContainerRef} from ' * * {@example common/ngIf/ts/module.ts region='NgIfElse'} * - * # Using non-inlined `then` template + * ## Using non-inlined `then` template * * Usually the `then` template is the inlined template of the `ngIf`, but it can be changed using * a binding (just like `else`). Because `then` and `else` are bindings, the template references can @@ -40,7 +40,7 @@ import {Directive, EmbeddedViewRef, Input, TemplateRef, ViewContainerRef} from ' * * {@example common/ngIf/ts/module.ts region='NgIfThenElse'} * - * # Storing conditional result in a variable + * ## Storing conditional result in a variable * * A common pattern is that we need to show a set of properties from the same object. If the * object is undefined, then we have to use the safe-traversal-operator `?.` to guard against diff --git a/packages/common/src/directives/ng_template_outlet.ts b/packages/common/src/directives/ng_template_outlet.ts index 9e3df0549f..ccfa8ecee4 100644 --- a/packages/common/src/directives/ng_template_outlet.ts +++ b/packages/common/src/directives/ng_template_outlet.ts @@ -26,7 +26,7 @@ import {Directive, EmbeddedViewRef, Input, OnChanges, SimpleChanges, TemplateRef * * Note: using the key `$implicit` in the context object will set it's value as default. * - * # Example + * ## Example * * {@example common/ngTemplateOutlet/ts/module.ts region='NgTemplateOutlet'} *