Skip to content

Improve JSDoc comments#2883

Merged
marvinhagemeister merged 6 commits intomasterfrom
improve-jsdoc
Dec 25, 2020
Merged

Improve JSDoc comments#2883
marvinhagemeister merged 6 commits intomasterfrom
improve-jsdoc

Conversation

@andrewiggins
Copy link
Copy Markdown
Member

@andrewiggins andrewiggins commented Dec 23, 2020 •
edited
Loading

This PR improves our JSDoc comments in the core rendered source to the point where there are only 3 (!) tsc --checkJS errors. Those remaining ones will go away with the work being done in the restructure branch.

Let me know your thoughts!

image

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Dec 23, 2020 •
edited
Loading

📊 Tachometer Benchmark Results

Summary

duration

  • 02_replace1k: unsure 🔍 -1% - +0% (-1.80ms - +0.15ms)
    preact-local vs preact-master
  • 03_update10th1k_x16: unsure 🔍 -0% - +7% (-0.06ms - +2.09ms)
    preact-local vs preact-master
  • 07_create10k: unsure 🔍 -1% - +5% (-20.45ms - +67.19ms)
    preact-local vs preact-master
  • filter_list: unsure 🔍 -2% - +4% (-0.73ms - +1.33ms)
    preact-local vs preact-master
  • hydrate1k: unsure 🔍 -3% - +2% (-4.68ms - +3.87ms)
    preact-local vs preact-master
  • many_updates: unsure 🔍 -7% - +6% (-2.50ms - +2.32ms)
    preact-local vs preact-master
  • text_update: unsure 🔍 -1% - +2% (-0.03ms - +0.06ms)
    preact-local vs preact-master

usedJSHeapSize

  • 02_replace1k: unsure 🔍 -0% - +0% (-0.00ms - +0.01ms)
    preact-local vs preact-master
  • 03_update10th1k_x16: unsure 🔍 -0% - +0% (-0.00ms - +0.01ms)
    preact-local vs preact-master
  • 07_create10k: unsure 🔍 -0% - +0% (-0.00ms - +0.00ms)
    preact-local vs preact-master
  • filter_list: unsure 🔍 -0% - +0% (-0.00ms - +0.00ms)
    preact-local vs preact-master
  • hydrate1k: unsure 🔍 -0% - +0% (-0.00ms - +0.00ms)
    preact-local vs preact-master
  • many_updates: unsure 🔍 -0% - +0% (-0.00ms - +0.00ms)
    preact-local vs preact-master
  • text_update: unsure 🔍 +0% - +0% (+0.00ms - +0.00ms)
    preact-local vs preact-master

Results

02_replace1k
  • Browser: chrome-headless 87.0.4280.88
  • Sample size: 80
  • Built by: CI #603

  • Commit: 6f7dd18

duration

VersionAvg timevs preact-mastervs preact-local
preact-master160.37ms - 162.14ms-unsure 🔍
-0% - +1%
-0.15ms - +1.80ms
preact-local160.01ms - 160.85msunsure 🔍
-1% - +0%
-1.80ms - +0.15ms		-

usedJSHeapSize

VersionAvg timevs preact-mastervs preact-local
preact-master3.60ms - 3.61ms-unsure 🔍
-0% - +0%
-0.01ms - +0.00ms
preact-local3.61ms - 3.62msunsure 🔍
-0% - +0%
-0.00ms - +0.01ms		-

run-warmup-0

VersionAvg timevs preact-mastervs preact-local
preact-master56.33ms - 56.80ms-unsure 🔍
-3% - +1%
-1.52ms - +0.30ms
preact-local56.30ms - 58.06msunsure 🔍
-1% - +3%
-0.30ms - +1.52ms		-

run-warmup-1

VersionAvg timevs preact-mastervs preact-local
preact-master88.33ms - 89.06ms-unsure 🔍
-1% - +1%
-0.60ms - +0.47ms
preact-local88.37ms - 89.16msunsure 🔍
-1% - +1%
-0.47ms - +0.60ms		-

run-warmup-2

VersionAvg timevs preact-mastervs preact-local
preact-master101.36ms - 104.10ms-unsure 🔍
-2% - +1%
-1.92ms - +0.98ms
preact-local102.71ms - 103.69msunsure 🔍
-1% - +2%
-0.98ms - +1.92ms		-

run-warmup-3

VersionAvg timevs preact-mastervs preact-local
preact-master56.93ms - 58.86ms-unsure 🔍
-1% - +3%
-0.41ms - +1.58ms
preact-local57.08ms - 57.54msunsure 🔍
-3% - +1%
-1.58ms - +0.41ms		-

run-warmup-4

VersionAvg timevs preact-mastervs preact-local
preact-master100.61ms - 106.24ms-faster ✔
0% - 7%
0.16ms - 7.92ms
preact-local104.79ms - 110.14msslower ❌
0% - 8%
0.16ms - 7.92ms		-

run-final

VersionAvg timevs preact-mastervs preact-local
preact-master56.75ms - 58.32ms-unsure 🔍
-0% - +2%
-0.19ms - +1.42ms
preact-local56.75ms - 57.10msunsure 🔍
-2% - +0%
-1.42ms - +0.19ms		-
03_update10th1k_x16
  • Browser: chrome-headless 87.0.4280.88
  • Sample size: 130
  • Built by: CI #603

  • Commit: 6f7dd18

duration

VersionAvg timevs preact-mastervs preact-local
preact-master29.08ms - 30.35ms-unsure 🔍
-7% - +0%
-2.09ms - +0.06ms
preact-local29.87ms - 31.59msunsure 🔍
-0% - +7%
-0.06ms - +2.09ms		-

usedJSHeapSize

VersionAvg timevs preact-mastervs preact-local
preact-master3.52ms - 3.53ms-unsure 🔍
-0% - +0%
-0.01ms - +0.00ms
preact-local3.52ms - 3.53msunsure 🔍
-0% - +0%
-0.00ms - +0.01ms		-
07_create10k
  • Browser: chrome-headless 87.0.4280.88
  • Sample size: 50
  • Built by: CI #603

  • Commit: 6f7dd18

duration

VersionAvg timevs preact-mastervs preact-local
preact-master1398.76ms - 1429.85ms-unsure 🔍
-5% - +1%
-67.19ms - +20.45ms
preact-local1396.71ms - 1478.64msunsure 🔍
-1% - +5%
-20.45ms - +67.19ms		-

usedJSHeapSize

VersionAvg timevs preact-mastervs preact-local
preact-master25.99ms - 25.99ms-unsure 🔍
-0% - +0%
-0.00ms - +0.00ms
preact-local25.99ms - 25.99msunsure 🔍
-0% - +0%
-0.00ms - +0.00ms		-
filter_list
  • Browser: chrome-headless 87.0.4280.88
  • Sample size: 50
  • Built by: CI #603

  • Commit: 6f7dd18

duration

VersionAvg timevs preact-mastervs preact-local
preact-master29.18ms - 30.19ms-unsure 🔍
-4% - +2%
-1.33ms - +0.73ms
preact-local29.09ms - 30.88msunsure 🔍
-2% - +4%
-0.73ms - +1.33ms		-

usedJSHeapSize

VersionAvg timevs preact-mastervs preact-local
preact-master1.60ms - 1.60ms-unsure 🔍
-0% - +0%
-0.00ms - +0.00ms
preact-local1.60ms - 1.60msunsure 🔍
-0% - +0%
-0.00ms - +0.00ms		-
hydrate1k
  • Browser: chrome-headless 87.0.4280.88
  • Sample size: 50
  • Built by: CI #603

  • Commit: 6f7dd18

duration

VersionAvg timevs preact-mastervs preact-local
preact-master166.46ms - 172.62ms-unsure 🔍
-2% - +3%
-3.87ms - +4.68ms
preact-local166.17ms - 172.10msunsure 🔍
-3% - +2%
-4.68ms - +3.87ms		-

usedJSHeapSize

VersionAvg timevs preact-mastervs preact-local
preact-master6.19ms - 6.19ms-unsure 🔍
-0% - +0%
-0.00ms - +0.00ms
preact-local6.19ms - 6.20msunsure 🔍
-0% - +0%
-0.00ms - +0.00ms		-
many_updates
  • Browser: chrome-headless 87.0.4280.88
  • Sample size: 80
  • Built by: CI #603

  • Commit: 6f7dd18

duration

VersionAvg timevs preact-mastervs preact-local
preact-master33.95ms - 37.51ms-unsure 🔍
-7% - +7%
-2.32ms - +2.50ms
preact-local34.01ms - 37.27msunsure 🔍
-7% - +6%
-2.50ms - +2.32ms		-

usedJSHeapSize

VersionAvg timevs preact-mastervs preact-local
preact-master4.85ms - 4.85ms-unsure 🔍
-0% - +0%
-0.00ms - +0.00ms
preact-local4.85ms - 4.85msunsure 🔍
-0% - +0%
-0.00ms - +0.00ms		-
text_update
  • Browser: chrome-headless 87.0.4280.88
  • Sample size: 50
  • Built by: CI #603

  • Commit: 6f7dd18

duration

VersionAvg timevs preact-mastervs preact-local
preact-master2.98ms - 3.05ms-unsure 🔍
-2% - +1%
-0.06ms - +0.03ms
preact-local3.00ms - 3.05msunsure 🔍
-1% - +2%
-0.03ms - +0.06ms		-

usedJSHeapSize

VersionAvg timevs preact-mastervs preact-local
preact-master0.83ms - 0.83ms-unsure 🔍
-0% - -0%
-0.00ms - -0.00ms
preact-local0.83ms - 0.83msunsure 🔍
+0% - +0%
+0.00ms - +0.00ms		-

tachometer-reporter-action v2 for CI

@coveralls
Copy link
Copy Markdown

coveralls commented Dec 23, 2020

Coverage Status

Coverage remained the same at 100.0% when pulling 95d60a2 on improve-jsdoc into e8a4c46 on master.

@andrewiggins andrewiggins mentioned this pull request Dec 23, 2020
Closed
@andrewiggins
Copy link
Copy Markdown
Member Author

andrewiggins commented Dec 23, 2020

Huh... no clue why the compressed-size-action is failing...

marvinhagemeister
marvinhagemeister approved these changes Dec 25, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@marvinhagemeister marvinhagemeister left a comment

Choose a reason for hiding this comment

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

This is awesome 🙌

@marvinhagemeister marvinhagemeister merged commit 37a884c into master Dec 25, 2020
@marvinhagemeister marvinhagemeister deleted the improve-jsdoc branch December 25, 2020 07:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@marvinhagemeister marvinhagemeister marvinhagemeister approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@andrewiggins @coveralls @marvinhagemeister