[lit-html] svg tag function JSDoc replace 'rare' with 'invalid'

[AndrewJakubowicz]

Include Justin's feedback on #2479.
Link to feedback: #2479 (comment)

Replace 'rare' with 'invalid' and reflow markdown

[changeset-bot]

🦋 Changeset detected

Latest commit: 750a7c0

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

📊 Tachometer Benchmark Results

Summary

nop-update

• lit-html-kitchen-sink: unsure 🔍 -2% - +3% (-0.52ms - +0.70ms)
  ^{this-change vs tip-of-tree}

render

• lit-element-list: unsure 🔍 -2% - +0% (-1.84ms - +0.21ms)
  ^{this-change vs tip-of-tree}
• lit-html-kitchen-sink: unsure 🔍 -1% - +0% (-0.41ms - +0.13ms)
  ^{this-change vs tip-of-tree}
• lit-html-repeat: unsure 🔍 -2% - +2% (-0.23ms - +0.20ms)
  ^{this-change vs tip-of-tree}
• lit-html-template-heavy: unsure 🔍 -8% - +4% (-4.23ms - +2.42ms)
  ^{this-change vs tip-of-tree}
• reactive-element-list: unsure 🔍 -3% - +1% (-1.48ms - +0.57ms)
  ^{this-change vs tip-of-tree}

update

• lit-element-list: unsure 🔍 -0% - +2% (-2.10ms - +12.07ms)
  ^{this-change vs tip-of-tree}
• lit-html-kitchen-sink: unsure 🔍 -1% - +3% (-0.55ms - +2.31ms)
  ^{this-change vs tip-of-tree}
• lit-html-repeat: unsure 🔍 -0% - +2% (-1.17ms - +5.02ms)
  ^{this-change vs tip-of-tree}
• lit-html-template-heavy: unsure 🔍 -1% - +3% (-1.33ms - +3.15ms)
  ^{this-change vs tip-of-tree}
• reactive-element-list: unsure 🔍 -2% - +1% (-11.45ms - +7.51ms)
  ^{this-change vs tip-of-tree}

update-reflect

• lit-element-list: unsure 🔍 -1% - +2% (-10.78ms - +19.59ms)
  ^{this-change vs tip-of-tree}
• reactive-element-list: unsure 🔍 -2% - +1% (-13.86ms - +6.42ms)
  ^{this-change vs tip-of-tree}

Results

lit-element-list

• Browser: chrome-headless 97.0.4692.99
• Sample size: 50
• Built by: Benchmarks #2347

• Commit: eb64069

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	73.86ms - 74.89ms	-	unsure 🔍 -2% - +0% -1.84ms - +0.21ms	faster ✔ 20% - 21% 18.41ms - 20.20ms
tip-of-tree tip-of-tree	74.30ms - 76.08ms	unsure 🔍 -0% - +2% -0.21ms - +1.84ms	-	faster ✔ 19% - 21% 17.34ms - 19.64ms
previous-release previous-release	92.95ms - 94.41ms	slower ❌ 25% - 27% 18.41ms - 20.20ms	slower ❌ 23% - 26% 17.34ms - 19.64ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	730.62ms - 740.16ms	-	unsure 🔍 -0% - +2% -2.10ms - +12.07ms	faster ✔ 7% - 9% 54.68ms - 68.23ms
tip-of-tree tip-of-tree	725.16ms - 735.64ms	unsure 🔍 -2% - +0% -12.07ms - +2.10ms	-	faster ✔ 7% - 9% 59.33ms - 73.56ms
previous-release previous-release	792.03ms - 801.66ms	slower ❌ 7% - 9% 54.68ms - 68.23ms	slower ❌ 8% - 10% 59.33ms - 73.56ms	-

update-reflect

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	812.66ms - 841.46ms	-	unsure 🔍 -1% - +2% -10.78ms - +19.59ms	faster ✔ 1% - 5% 11.10ms - 41.85ms
tip-of-tree tip-of-tree	817.83ms - 827.49ms	unsure 🔍 -2% - +1% -19.59ms - +10.78ms	-	faster ✔ 3% - 4% 23.64ms - 38.12ms
previous-release previous-release	848.15ms - 858.93ms	slower ❌ 1% - 5% 11.10ms - 41.85ms	slower ❌ 3% - 5% 23.64ms - 38.12ms	-

lit-html-kitchen-sink

• Browser: chrome-headless 97.0.4692.99
• Sample size: 30
• Built by: Benchmarks #2347

• Commit: eb64069

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	29.64ms - 29.95ms	-	unsure 🔍 -1% - +0% -0.41ms - +0.13ms	faster ✔ 13% - 19% 4.59ms - 6.75ms
tip-of-tree tip-of-tree	29.72ms - 30.16ms	unsure 🔍 -0% - +1% -0.13ms - +0.41ms	-	faster ✔ 13% - 18% 4.44ms - 6.62ms
previous-release previous-release	34.40ms - 36.53ms	slower ❌ 15% - 23% 4.59ms - 6.75ms	slower ❌ 15% - 22% 4.44ms - 6.62ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	79.50ms - 81.58ms	-	unsure 🔍 -1% - +3% -0.55ms - +2.31ms	faster ✔ 0% - 5% 0.18ms - 4.47ms
tip-of-tree tip-of-tree	78.67ms - 80.64ms	unsure 🔍 -3% - +1% -2.31ms - +0.55ms	-	faster ✔ 1% - 6% 1.09ms - 5.33ms
previous-release previous-release	80.99ms - 84.74ms	slower ❌ 0% - 6% 0.18ms - 4.47ms	slower ❌ 1% - 7% 1.09ms - 5.33ms	-

nop-update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	25.51ms - 26.59ms	-	unsure 🔍 -2% - +3% -0.52ms - +0.70ms	faster ✔ 9% - 13% 2.65ms - 3.87ms
tip-of-tree tip-of-tree	25.68ms - 26.24ms	unsure 🔍 -3% - +2% -0.70ms - +0.52ms	-	faster ✔ 10% - 13% 2.95ms - 3.75ms
previous-release previous-release	29.02ms - 29.60ms	slower ❌ 10% - 15% 2.65ms - 3.87ms	slower ❌ 11% - 15% 2.95ms - 3.75ms	-

lit-html-repeat

• Browser: chrome-headless 97.0.4692.99
• Sample size: 30
• Built by: Benchmarks #2347

• Commit: eb64069

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	11.02ms - 11.31ms	-	unsure 🔍 -2% - +2% -0.23ms - +0.20ms	faster ✔ 10% - 12% 1.20ms - 1.51ms
tip-of-tree tip-of-tree	11.02ms - 11.33ms	unsure 🔍 -2% - +2% -0.20ms - +0.23ms	-	faster ✔ 9% - 12% 1.17ms - 1.51ms
previous-release previous-release	12.47ms - 12.57ms	slower ❌ 11% - 14% 1.20ms - 1.51ms	slower ❌ 10% - 14% 1.17ms - 1.51ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	299.93ms - 303.11ms	-	unsure 🔍 -0% - +2% -1.17ms - +5.02ms	faster ✔ 30% - 31% 129.34ms - 136.35ms
tip-of-tree tip-of-tree	296.94ms - 302.25ms	unsure 🔍 -2% - +0% -5.02ms - +1.17ms	-	faster ✔ 30% - 32% 130.67ms - 138.87ms
previous-release previous-release	431.24ms - 437.48ms	slower ❌ 43% - 45% 129.34ms - 136.35ms	slower ❌ 43% - 47% 130.67ms - 138.87ms	-

lit-html-template-heavy

• Browser: chrome-headless 97.0.4692.99
• Sample size: 50
• Built by: Benchmarks #2347

• Commit: eb64069

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	53.10ms - 55.39ms	-	unsure 🔍 -8% - +4% -4.23ms - +2.42ms	faster ✔ 15% - 20% 9.95ms - 12.93ms
tip-of-tree tip-of-tree	52.02ms - 58.27ms	unsure 🔍 -4% - +8% -2.42ms - +4.23ms	-	faster ✔ 11% - 21% 7.27ms - 13.80ms
previous-release previous-release	64.73ms - 66.63ms	slower ❌ 18% - 24% 9.95ms - 12.93ms	slower ❌ 12% - 26% 7.27ms - 13.80ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	113.28ms - 116.67ms	-	unsure 🔍 -1% - +3% -1.33ms - +3.15ms	faster ✔ 12% - 15% 15.37ms - 20.23ms
tip-of-tree tip-of-tree	112.59ms - 115.54ms	unsure 🔍 -3% - +1% -3.15ms - +1.33ms	-	faster ✔ 13% - 16% 16.43ms - 21.00ms
previous-release previous-release	131.03ms - 134.52ms	slower ❌ 13% - 18% 15.37ms - 20.23ms	slower ❌ 14% - 19% 16.43ms - 21.00ms	-

reactive-element-list

• Browser: chrome-headless 97.0.4692.99
• Sample size: 50
• Built by: Benchmarks #2347

• Commit: eb64069

render

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	53.34ms - 54.86ms	-	unsure 🔍 -3% - +1% -1.48ms - +0.57ms	unsure 🔍 -3% - +1% -1.39ms - +0.63ms
tip-of-tree tip-of-tree	53.87ms - 55.25ms	unsure 🔍 -1% - +3% -0.57ms - +1.48ms	-	unsure 🔍 -2% - +2% -0.88ms - +1.04ms
previous-release previous-release	53.81ms - 55.14ms	unsure 🔍 -1% - +3% -0.63ms - +1.39ms	unsure 🔍 -2% - +2% -1.04ms - +0.88ms	-

update

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	731.39ms - 746.59ms	-	unsure 🔍 -2% - +1% -11.45ms - +7.51ms	unsure 🔍 -1% - +2% -7.60ms - +12.97ms
tip-of-tree tip-of-tree	735.30ms - 746.63ms	unsure 🔍 -1% - +2% -7.51ms - +11.45ms	-	unsure 🔍 -1% - +2% -4.29ms - +13.61ms
previous-release previous-release	729.37ms - 743.24ms	unsure 🔍 -2% - +1% -12.97ms - +7.60ms	unsure 🔍 -2% - +1% -13.61ms - +4.29ms	-

update-reflect

Version	Avg time	vs this-change	vs tip-of-tree tip-of-tree	vs previous-release previous-release
this-change	827.94ms - 843.86ms	-	unsure 🔍 -2% - +1% -13.86ms - +6.42ms	unsure 🔍 -1% - +1% -10.37ms - +11.27ms
tip-of-tree tip-of-tree	833.35ms - 845.90ms	unsure 🔍 -1% - +2% -6.42ms - +13.86ms	-	unsure 🔍 -1% - +2% -5.48ms - +13.83ms
previous-release previous-release	828.12ms - 842.78ms	unsure 🔍 -1% - +1% -11.27ms - +10.37ms	unsure 🔍 -2% - +1% -13.83ms - +5.48ms	-

_{tachometer-reporter-action v2 for Benchmarks}