Skip to content

Commit

Permalink
[lit-html] svg tag function JSDoc replace 'rare' with 'invalid' (#2498)
Browse files Browse the repository at this point in the history
Include Justin's feedback on #2479.
Replace 'rare' with 'invalid' and reflow markdown.


Co-authored-by: Andrew Jakubowicz <ajakubowicz@google.com>
  • Loading branch information
AndrewJakubowicz and AndrewJakubowicz committed Feb 7, 2022
1 parent 6ea3d6c commit 2a1dc7a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
6 changes: 6 additions & 0 deletions .changeset/curvy-candles-drum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'lit-html': patch
'lit': patch
---

Replace 'rare' with 'invalid' in svg tag function JSDocs.
6 changes: 3 additions & 3 deletions packages/lit-html/src/lit-html.ts
Original file line number Diff line number Diff line change
Expand Up @@ -341,9 +341,9 @@ export const html = tag(HTML_RESULT);
* function. The `<svg>` element is an HTML element and should be used within a
* template tagged with the {@linkcode html} tag function.
*
* In LitElement usage, it's rare to return an SVG fragment from the `render()`
* method, as the SVG fragment will be contained within the element's shadow
* root and thus cannot be used within an `<svg>` HTML element.
* In LitElement usage, it's invalid to return an SVG fragment from the
* `render()` method, as the SVG fragment will be contained within the element's
* shadow root and thus cannot be used within an `<svg>` HTML element.
*/
export const svg = tag(SVG_RESULT);

Expand Down

0 comments on commit 2a1dc7a

Please sign in to comment.