Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[reactive-element] Add types to query, query-async, and queryAll jsdoc code examples #2688

Merged
merged 2 commits into from
Apr 8, 2022

Conversation

AndrewJakubowicz
Copy link
Contributor

Add explicit types to the code samples showing example usage of query, queryAll, and queryAsync.

@changeset-bot
Copy link

changeset-bot bot commented Mar 31, 2022

🦋 Changeset detected

Latest commit: de6c297

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
Copy link
Contributor

github-actions bot commented Mar 31, 2022

📊 Tachometer Benchmark Results

Summary

nop-update

  • lit-html-kitchen-sink: unsure 🔍 -4% - +5% (-1.44ms - +1.62ms)
    this-change vs tip-of-tree

render

  • lit-element-list: unsure 🔍 -2% - +3% (-1.84ms - +3.23ms)
    this-change vs tip-of-tree
  • lit-html-kitchen-sink: unsure 🔍 -1% - +4% (-0.53ms - +1.92ms)
    this-change vs tip-of-tree
  • lit-html-repeat: unsure 🔍 -3% - +4% (-0.47ms - +0.55ms)
    this-change vs tip-of-tree
  • lit-html-template-heavy: unsure 🔍 -3% - +0% (-2.49ms - +0.18ms)
    this-change vs tip-of-tree
  • reactive-element-list: unsure 🔍 -1% - +4% (-0.63ms - +2.94ms)
    this-change vs tip-of-tree

update

  • lit-element-list: unsure 🔍 -1% - +1% (-13.76ms - +7.26ms)
    this-change vs tip-of-tree
  • lit-html-kitchen-sink: unsure 🔍 -1% - +6% (-1.37ms - +6.75ms)
    this-change vs tip-of-tree
  • lit-html-repeat: unsure 🔍 -2% - +1% (-8.75ms - +3.94ms)
    this-change vs tip-of-tree
  • lit-html-template-heavy: unsure 🔍 -1% - +4% (-2.50ms - +6.01ms)
    this-change vs tip-of-tree
  • reactive-element-list: unsure 🔍 -1% - +1% (-6.43ms - +12.82ms)
    this-change vs tip-of-tree

update-reflect

  • lit-element-list: unsure 🔍 -1% - +1% (-6.99ms - +13.29ms)
    this-change vs tip-of-tree
  • reactive-element-list: unsure 🔍 -0% - +1% (-1.88ms - +15.14ms)
    this-change vs tip-of-tree

Results

lit-element-list

render

VersionAvg timevs this-change
vs tip-of-tree
tip-of-tree
vs previous-release
previous-release
this-change
109.75ms - 113.26ms-unsure 🔍
-2% - +3%
-1.84ms - +3.23ms
faster ✔
20% - 23%
27.57ms - 32.79ms
tip-of-tree
tip-of-tree
108.99ms - 112.64msunsure 🔍
-3% - +2%
-3.23ms - +1.84ms
-faster ✔
20% - 23%
28.22ms - 33.53ms
previous-release
previous-release
139.76ms - 143.62msslower ❌
24% - 30%
27.57ms - 32.79ms
slower ❌
25% - 31%
28.22ms - 33.53ms
-

update

VersionAvg timevs this-change
vs tip-of-tree
tip-of-tree
vs previous-release
previous-release
this-change
1039.24ms - 1053.34ms-unsure 🔍
-1% - +1%
-13.76ms - +7.26ms
faster ✔
7% - 8%
76.94ms - 96.42ms
tip-of-tree
tip-of-tree
1041.74ms - 1057.33msunsure 🔍
-1% - +1%
-7.26ms - +13.76ms
-faster ✔
6% - 8%
73.14ms - 93.72ms
previous-release
previous-release
1126.25ms - 1139.69msslower ❌
7% - 9%
76.94ms - 96.42ms
slower ❌
7% - 9%
73.14ms - 93.72ms
-

update-reflect

VersionAvg timevs this-change
vs tip-of-tree
tip-of-tree
vs previous-release
previous-release
this-change
1138.56ms - 1152.42ms-unsure 🔍
-1% - +1%
-6.99ms - +13.29ms
faster ✔
4% - 6%
50.53ms - 69.82ms
tip-of-tree
tip-of-tree
1134.94ms - 1149.74msunsure 🔍
-1% - +1%
-13.29ms - +6.99ms
-faster ✔
4% - 6%
53.34ms - 73.32ms
previous-release
previous-release
1198.96ms - 1212.37msslower ❌
4% - 6%
50.53ms - 69.82ms
slower ❌
5% - 6%
53.34ms - 73.32ms
-
lit-html-kitchen-sink

render

VersionAvg timevs this-change
vs tip-of-tree
tip-of-tree
vs previous-release
previous-release
this-change
44.23ms - 46.32ms-unsure 🔍
-1% - +4%
-0.53ms - +1.92ms
faster ✔
10% - 15%
5.10ms - 7.68ms
tip-of-tree
tip-of-tree
43.94ms - 45.22msunsure 🔍
-4% - +1%
-1.92ms - +0.53ms
-faster ✔
12% - 15%
6.09ms - 8.08ms
previous-release
previous-release
50.90ms - 52.42msslower ❌
11% - 17%
5.10ms - 7.68ms
slower ❌
14% - 18%
6.09ms - 8.08ms
-

update

VersionAvg timevs this-change
vs tip-of-tree
tip-of-tree
vs previous-release
previous-release
this-change
121.74ms - 127.57ms-unsure 🔍
-1% - +6%
-1.37ms - +6.75ms
unsure 🔍
-4% - +3%
-4.42ms - +4.10ms
tip-of-tree
tip-of-tree
119.14ms - 124.80msunsure 🔍
-5% - +1%
-6.75ms - +1.37ms
-unsure 🔍
-6% - +1%
-7.05ms - +1.35ms
previous-release
previous-release
121.72ms - 127.92msunsure 🔍
-3% - +4%
-4.10ms - +4.42ms
unsure 🔍
-1% - +6%
-1.35ms - +7.05ms
-

nop-update

VersionAvg timevs this-change
vs tip-of-tree
tip-of-tree
vs previous-release
previous-release
this-change
34.88ms - 36.98ms-unsure 🔍
-4% - +5%
-1.44ms - +1.62ms
faster ✔
10% - 16%
4.07ms - 6.71ms
tip-of-tree
tip-of-tree
34.72ms - 36.95msunsure 🔍
-5% - +4%
-1.62ms - +1.44ms
-faster ✔
10% - 16%
4.11ms - 6.85ms
previous-release
previous-release
40.52ms - 42.12msslower ❌
11% - 19%
4.07ms - 6.71ms
slower ❌
11% - 20%
4.11ms - 6.85ms
-
lit-html-repeat

render

VersionAvg timevs this-change
vs tip-of-tree
tip-of-tree
vs previous-release
previous-release
this-change
14.01ms - 14.83ms-unsure 🔍
-3% - +4%
-0.47ms - +0.55ms
faster ✔
10% - 15%
1.60ms - 2.55ms
tip-of-tree
tip-of-tree
14.08ms - 14.68msunsure 🔍
-4% - +3%
-0.55ms - +0.47ms
-faster ✔
11% - 15%
1.73ms - 2.50ms
previous-release
previous-release
16.26ms - 16.74msslower ❌
11% - 18%
1.60ms - 2.55ms
slower ❌
12% - 18%
1.73ms - 2.50ms
-

update

VersionAvg timevs this-change
vs tip-of-tree
tip-of-tree
vs previous-release
previous-release
this-change
372.52ms - 380.48ms-unsure 🔍
-2% - +1%
-8.75ms - +3.94ms
faster ✔
31% - 32%
166.88ms - 178.37ms
tip-of-tree
tip-of-tree
373.96ms - 383.85msunsure 🔍
-1% - +2%
-3.94ms - +8.75ms
-faster ✔
30% - 32%
163.77ms - 176.67ms
previous-release
previous-release
544.98ms - 553.27msslower ❌
44% - 48%
166.88ms - 178.37ms
slower ❌
43% - 47%
163.77ms - 176.67ms
-
lit-html-template-heavy

render

VersionAvg timevs this-change
vs tip-of-tree
tip-of-tree
vs previous-release
previous-release
this-change
72.16ms - 73.91ms-unsure 🔍
-3% - +0%
-2.49ms - +0.18ms
faster ✔
14% - 17%
12.43ms - 15.32ms
tip-of-tree
tip-of-tree
73.19ms - 75.19msunsure 🔍
-0% - +3%
-0.18ms - +2.49ms
-faster ✔
13% - 16%
11.19ms - 14.24ms
previous-release
previous-release
85.76ms - 88.06msslower ❌
17% - 21%
12.43ms - 15.32ms
slower ❌
15% - 19%
11.19ms - 14.24ms
-

update

VersionAvg timevs this-change
vs tip-of-tree
tip-of-tree
vs previous-release
previous-release
this-change
169.15ms - 175.85ms-unsure 🔍
-1% - +4%
-2.50ms - +6.01ms
faster ✔
8% - 12%
14.68ms - 22.83ms
tip-of-tree
tip-of-tree
168.12ms - 173.37msunsure 🔍
-3% - +1%
-6.01ms - +2.50ms
-faster ✔
9% - 12%
17.01ms - 24.01ms
previous-release
previous-release
188.94ms - 193.57msslower ❌
8% - 13%
14.68ms - 22.83ms
slower ❌
10% - 14%
17.01ms - 24.01ms
-
reactive-element-list

render

VersionAvg timevs this-change
vs tip-of-tree
tip-of-tree
vs previous-release
previous-release
this-change
75.68ms - 78.71ms-unsure 🔍
-1% - +4%
-0.63ms - +2.94ms
unsure 🔍
-2% - +3%
-1.83ms - +2.58ms
tip-of-tree
tip-of-tree
75.10ms - 76.99msunsure 🔍
-4% - +1%
-2.94ms - +0.63ms
-unsure 🔍
-3% - +1%
-2.64ms - +1.08ms
previous-release
previous-release
75.22ms - 78.43msunsure 🔍
-3% - +2%
-2.58ms - +1.83ms
unsure 🔍
-1% - +3%
-1.08ms - +2.64ms
-

update

VersionAvg timevs this-change
vs tip-of-tree
tip-of-tree
vs previous-release
previous-release
this-change
1091.17ms - 1104.45ms-unsure 🔍
-1% - +1%
-6.43ms - +12.82ms
unsure 🔍
-1% - +1%
-10.86ms - +9.20ms
tip-of-tree
tip-of-tree
1087.65ms - 1101.58msunsure 🔍
-1% - +1%
-12.82ms - +6.43ms
-unsure 🔍
-1% - +1%
-14.28ms - +6.22ms
previous-release
previous-release
1091.13ms - 1106.17msunsure 🔍
-1% - +1%
-9.20ms - +10.86ms
unsure 🔍
-1% - +1%
-6.22ms - +14.28ms
-

update-reflect

VersionAvg timevs this-change
vs tip-of-tree
tip-of-tree
vs previous-release
previous-release
this-change
1205.47ms - 1218.18ms-unsure 🔍
-0% - +1%
-1.88ms - +15.14ms
unsure 🔍
-0% - +1%
-5.92ms - +15.14ms
tip-of-tree
tip-of-tree
1199.54ms - 1210.86msunsure 🔍
-1% - +0%
-15.14ms - +1.88ms
-unsure 🔍
-1% - +1%
-12.15ms - +8.11ms
previous-release
previous-release
1198.82ms - 1215.62msunsure 🔍
-1% - +0%
-15.14ms - +5.92ms
unsure 🔍
-1% - +1%
-8.11ms - +12.15ms
-

tachometer-reporter-action v2 for Benchmarks

Copy link
Member

@augustjk augustjk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Woohoo, better docs!

@AndrewJakubowicz AndrewJakubowicz merged commit ef178ef into main Apr 8, 2022
@AndrewJakubowicz AndrewJakubowicz deleted the add-doc-types branch April 8, 2022 22:29
@lit-robot lit-robot mentioned this pull request Apr 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants