From 42fc19839fe69693431e3e15a4f7c220ecc6b580 Mon Sep 17 00:00:00 2001 From: Andrew Jakubowicz Date: Mon, 9 May 2022 11:27:50 -0700 Subject: [PATCH] Add small amount of documentation to describe how to render a TemplateResult --- packages/lit-html/src/lit-html.ts | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/packages/lit-html/src/lit-html.ts b/packages/lit-html/src/lit-html.ts index 43ee5fe05a..9b6245c0fb 100644 --- a/packages/lit-html/src/lit-html.ts +++ b/packages/lit-html/src/lit-html.ts @@ -446,9 +446,14 @@ const COMMENT_PART = 7; * The return type of the template tag functions, {@linkcode html} and * {@linkcode svg}. * - * This object captures the arguments passed into the tag function. A special - * array of strings that retain their identity between multiple evaluations of - * the tagged literal, and the values from the interpolated expressions. + * The `TemplateResult` object captures the arguments passed into the tag + * function. A special array of strings that retain their identity between + * multiple evaluations of the tagged literal, and the values from the + * interpolated expressions. + * + * To create or update DOM from the `TemplateResult`, you need to + * {@linkcode render} the `TemplateResult`. Within LitElement return the + * `TemplateResult` from the `render()` method to render it. */ export type TemplateResult = { // This property needs to remain unminified.