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

Documentation in the VSCode - core, std, and current project #1466

Merged
merged 23 commits into from May 13, 2024

Conversation

DmitryVasilevsky
Copy link
Contributor

@DmitryVasilevsky DmitryVasilevsky commented May 2, 2024

This PR adds "Q#: Show API documentation" command to the command palette (F1). This command opens WebView window with concatenated documentation autogenerated from all doc comments for the standard library and currently opened project. It is searchable via FindWidget (Ctrl+F). This PR also enables FindWidget for all other WebView windows.

Future work:

  • Documentation is in random order. We may consider ordering it by namespace then function names
  • We may consider adding filter to the documentation - show only pieces that contain typed word
  • Telemetry

Copy link

github-actions bot commented May 2, 2024

Benchmark for b82bb5c

Click to view benchmark
Test Base PR %
Array append evaluation 338.3±1.22µs 341.9±2.22µs +1.06%
Array literal evaluation 173.6±1.23µs 192.9±2.72µs +11.12%
Array update evaluation 420.6±2.28µs 424.4±2.20µs +0.90%
Core + Standard library compilation 16.7±0.38ms 16.7±0.07ms 0.00%
Deutsch-Jozsa evaluation 5.1±0.04ms 5.1±0.32ms 0.00%
Large file parity evaluation 33.8±0.07ms 33.8±0.38ms 0.00%
Large input file compilation 11.4±0.38ms 11.2±0.09ms -1.75%
Large input file compilation (interpreter) 44.0±1.43ms 43.8±1.21ms -0.45%
Large nested iteration 33.4±1.26ms 33.4±0.13ms 0.00%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1499.8±45.97µs 1494.3±26.06µs -0.37%
Perform Runtime Capabilities Analysis (RCA) on large file sample 7.6±0.07ms 7.7±0.12ms +1.32%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1411.2±42.61µs 1408.2±37.64µs -0.21%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 21.1±0.19ms 21.0±0.32ms -0.47%
Teleport evaluation 89.3±3.60µs 90.4±3.54µs +1.23%

Copy link

github-actions bot commented May 2, 2024

Benchmark for ea73fa3

Click to view benchmark
Test Base PR %
Array append evaluation 343.8±4.06µs 342.9±3.35µs -0.26%
Array literal evaluation 192.7±0.82µs 193.0±3.88µs +0.16%
Array update evaluation 426.7±4.01µs 425.7±3.42µs -0.23%
Core + Standard library compilation 16.8±0.14ms 17.4±0.40ms +3.57%
Deutsch-Jozsa evaluation 5.1±0.05ms 5.1±0.07ms 0.00%
Large file parity evaluation 33.7±0.13ms 33.7±0.56ms 0.00%
Large input file compilation 11.6±0.44ms 11.5±0.29ms -0.86%
Large input file compilation (interpreter) 46.7±2.30ms 44.1±1.55ms -5.57%
Large nested iteration 33.5±0.24ms 33.6±0.55ms +0.30%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1494.9±40.96µs 1496.0±31.87µs +0.07%
Perform Runtime Capabilities Analysis (RCA) on large file sample 7.7±0.13ms 7.6±0.09ms -1.30%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1405.5±36.31µs 1404.4±33.73µs -0.08%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 21.1±0.21ms 21.2±0.35ms +0.47%
Teleport evaluation 88.8±3.79µs 91.3±16.16µs +2.82%

Copy link

github-actions bot commented May 2, 2024

Benchmark for d41a21e

Click to view benchmark
Test Base PR %
Array append evaluation 377.7±2.57µs 339.6±2.46µs -10.09%
Array literal evaluation 285.4±0.97µs 173.9±1.70µs -39.07%
Array update evaluation 420.1±3.19µs 419.1±2.39µs -0.24%
Core + Standard library compilation 17.5±0.54ms 17.3±0.38ms -1.14%
Deutsch-Jozsa evaluation 5.1±0.04ms 5.2±0.28ms +1.96%
Large file parity evaluation 33.9±0.13ms 33.7±0.30ms -0.59%
Large input file compilation 11.7±0.24ms 11.7±0.26ms 0.00%
Large input file compilation (interpreter) 46.7±2.05ms 46.5±1.60ms -0.43%
Large nested iteration 33.3±0.65ms 33.1±0.35ms -0.60%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1493.4±42.28µs 1499.2±33.34µs +0.39%
Perform Runtime Capabilities Analysis (RCA) on large file sample 7.8±0.13ms 7.8±0.25ms 0.00%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1410.0±62.81µs 1410.8±33.73µs +0.06%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 21.2±0.25ms 21.3±0.63ms +0.47%
Teleport evaluation 91.3±3.64µs 89.8±3.41µs -1.64%

Copy link

github-actions bot commented May 6, 2024

Benchmark for 966fe17

Click to view benchmark
Test Base PR %
Array append evaluation 342.6±7.45µs 350.1±9.55µs +2.19%
Array literal evaluation 181.7±3.58µs 180.1±4.97µs -0.88%
Array update evaluation 424.8±3.14µs 426.6±3.66µs +0.42%
Core + Standard library compilation 17.1±0.35ms 16.8±0.29ms -1.75%
Deutsch-Jozsa evaluation 5.0±0.04ms 5.0±0.04ms 0.00%
Large file parity evaluation 33.7±0.08ms 33.8±0.27ms +0.30%
Large input file compilation 11.6±0.25ms 11.6±0.22ms 0.00%
Large input file compilation (interpreter) 44.9±1.51ms 44.1±0.92ms -1.78%
Large nested iteration 33.6±0.57ms 33.4±0.79ms -0.60%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1494.5±58.91µs 1480.5±36.12µs -0.94%
Perform Runtime Capabilities Analysis (RCA) on large file sample 7.7±0.08ms 7.6±0.05ms -1.30%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1412.9±49.10µs 1401.7±58.70µs -0.79%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 20.8±0.29ms 20.4±0.37ms -1.92%
Teleport evaluation 87.5±3.57µs 88.2±3.38µs +0.80%

Copy link

github-actions bot commented May 7, 2024

Benchmark for bd0f7d6

Click to view benchmark
Test Base PR %
Array append evaluation 345.3±2.08µs 343.7±6.61µs -0.46%
Array literal evaluation 206.0±3.47µs 183.4±4.61µs -10.97%
Array update evaluation 427.9±1.77µs 433.1±5.12µs +1.22%
Core + Standard library compilation 18.9±0.80ms 17.7±1.01ms -6.35%
Deutsch-Jozsa evaluation 5.1±0.05ms 5.0±0.04ms -1.96%
Large file parity evaluation 33.8±0.08ms 33.8±0.39ms 0.00%
Large input file compilation 12.5±0.43ms 11.7±0.29ms -6.40%
Large input file compilation (interpreter) 48.6±1.22ms 46.0±1.53ms -5.35%
Large nested iteration 33.7±0.16ms 34.2±1.88ms +1.48%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1522.7±111.32µs 1501.4±55.72µs -1.40%
Perform Runtime Capabilities Analysis (RCA) on large file sample 7.7±0.12ms 7.7±0.11ms 0.00%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1435.2±91.96µs 1406.5±54.46µs -2.00%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 21.2±0.27ms 20.6±1.31ms -2.83%
Teleport evaluation 88.1±3.49µs 88.0±3.34µs -0.11%

vscode/package.json Outdated Show resolved Hide resolved
@DmitryVasilevsky DmitryVasilevsky changed the title First version of the documentation in the VSCode Documentation in the VSCode - core, std, and current project May 8, 2024
Copy link

github-actions bot commented May 8, 2024

Benchmark for 9f01650

Click to view benchmark
Test Base PR %
Array append evaluation 346.9±10.27µs 342.3±3.64µs -1.33%
Array literal evaluation 199.6±3.12µs 180.3±3.20µs -9.67%
Array update evaluation 429.5±7.73µs 424.2±15.15µs -1.23%
Core + Standard library compilation 18.2±0.93ms 19.5±0.78ms +7.14%
Deutsch-Jozsa evaluation 5.1±0.07ms 5.1±0.06ms 0.00%
Large file parity evaluation 34.0±1.21ms 34.0±0.42ms 0.00%
Large input file compilation 11.9±0.55ms 12.7±0.80ms +6.72%
Large input file compilation (interpreter) 48.0±1.68ms 49.4±0.98ms +2.92%
Large nested iteration 33.6±0.18ms 33.8±1.74ms +0.60%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1521.8±49.66µs 1520.4±123.83µs -0.09%
Perform Runtime Capabilities Analysis (RCA) on large file sample 8.0±0.15ms 7.9±0.15ms -1.25%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1433.0±60.01µs 1447.1±102.89µs +0.98%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 20.8±0.37ms 21.1±0.66ms +1.44%
Teleport evaluation 88.1±3.47µs 90.5±3.45µs +2.72%

vscode/src/documentation.ts Outdated Show resolved Hide resolved
Copy link

github-actions bot commented May 9, 2024

Benchmark for 42b87fe

Click to view benchmark
Test Base PR %
Array append evaluation 341.7±2.66µs 354.5±4.88µs +3.75%
Array literal evaluation 185.3±4.35µs 199.5±7.98µs +7.66%
Array update evaluation 424.8±3.67µs 425.6±3.03µs +0.19%
Core + Standard library compilation 16.8±0.32ms 17.0±0.38ms +1.19%
Deutsch-Jozsa evaluation 5.0±0.05ms 5.1±0.04ms +2.00%
Large file parity evaluation 34.4±0.50ms 34.1±0.26ms -0.87%
Large input file compilation 11.5±0.09ms 11.5±0.24ms 0.00%
Large input file compilation (interpreter) 45.2±1.22ms 46.1±1.28ms +1.99%
Large nested iteration 33.2±0.28ms 33.5±0.23ms +0.90%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1539.5±37.66µs 1542.2±39.19µs +0.18%
Perform Runtime Capabilities Analysis (RCA) on large file sample 7.6±0.07ms 7.7±0.09ms +1.32%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1409.4±33.52µs 1413.2±63.04µs +0.27%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 27.1±0.15ms 27.1±0.31ms 0.00%
Teleport evaluation 87.3±3.44µs 88.0±3.26µs +0.80%

Copy link

github-actions bot commented May 9, 2024

Benchmark for b4d5e76

Click to view benchmark
Test Base PR %
Array append evaluation 359.3±5.56µs 343.4±8.42µs -4.43%
Array literal evaluation 200.4±14.02µs 180.4±2.64µs -9.98%
Array update evaluation 426.6±9.17µs 423.5±4.52µs -0.73%
Core + Standard library compilation 19.3±1.04ms 17.5±0.46ms -9.33%
Deutsch-Jozsa evaluation 5.1±0.04ms 5.1±0.09ms 0.00%
Large file parity evaluation 33.8±0.11ms 33.9±0.44ms +0.30%
Large input file compilation 12.4±0.33ms 12.4±0.44ms 0.00%
Large input file compilation (interpreter) 48.5±1.19ms 48.3±2.15ms -0.41%
Large nested iteration 33.5±0.17ms 33.3±0.33ms -0.60%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1566.3±79.49µs 1547.8±59.31µs -1.18%
Perform Runtime Capabilities Analysis (RCA) on large file sample 7.9±0.25ms 7.7±0.10ms -2.53%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1428.5±40.80µs 1425.2±58.57µs -0.23%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 27.6±0.25ms 27.5±0.28ms -0.36%
Teleport evaluation 87.6±3.47µs 87.9±3.74µs +0.34%

Copy link

github-actions bot commented May 9, 2024

Benchmark for 9e30e27

Click to view benchmark
Test Base PR %
Array append evaluation 346.3±7.22µs 342.4±1.47µs -1.13%
Array literal evaluation 198.5±1.09µs 198.7±1.67µs +0.10%
Array update evaluation 425.8±4.18µs 423.8±1.56µs -0.47%
Core + Standard library compilation 19.6±0.83ms 20.0±0.88ms +2.04%
Deutsch-Jozsa evaluation 5.1±0.04ms 5.1±0.04ms 0.00%
Large file parity evaluation 34.0±0.24ms 33.9±0.45ms -0.29%
Large input file compilation 12.9±0.62ms 13.2±0.67ms +2.33%
Large input file compilation (interpreter) 48.5±1.18ms 49.2±1.20ms +1.44%
Large nested iteration 33.6±0.18ms 33.7±0.19ms +0.30%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1600.4±129.86µs 1593.4±136.10µs -0.44%
Perform Runtime Capabilities Analysis (RCA) on large file sample 8.3±0.15ms 8.0±0.13ms -3.61%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1468.7±147.15µs 1467.2±186.62µs -0.10%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 28.0±0.28ms 28.3±0.32ms +1.07%
Teleport evaluation 87.5±3.81µs 91.3±5.50µs +4.34%

Copy link

github-actions bot commented May 9, 2024

Benchmark for 529fcef

Click to view benchmark
Test Base PR %
Array append evaluation 355.7±1.73µs 371.5±2.18µs +4.44%
Array literal evaluation 180.2±1.16µs 199.8±2.58µs +10.88%
Array update evaluation 438.3±2.49µs 430.0±23.67µs -1.89%
Core + Standard library compilation 17.6±1.10ms 16.8±0.12ms -4.55%
Deutsch-Jozsa evaluation 5.1±0.08ms 5.1±0.29ms 0.00%
Large file parity evaluation 34.0±0.16ms 34.0±0.55ms 0.00%
Large input file compilation 11.7±0.47ms 12.0±0.76ms +2.56%
Large input file compilation (interpreter) 44.5±1.16ms 44.3±1.17ms -0.45%
Large nested iteration 35.0±0.31ms 33.8±0.36ms -3.43%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1552.8±38.29µs 1548.2±34.47µs -0.30%
Perform Runtime Capabilities Analysis (RCA) on large file sample 7.9±0.31ms 7.7±0.06ms -2.53%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1421.3±31.86µs 1416.5±40.51µs -0.34%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 27.5±0.31ms 27.1±0.19ms -1.45%
Teleport evaluation 88.5±4.77µs 88.8±6.03µs +0.34%

vscode/src/documentation.ts Outdated Show resolved Hide resolved
DmitryVasilevsky and others added 2 commits May 13, 2024 11:43
Co-authored-by: Alex Hansen <alex@alex-hansen.com>
Copy link

Benchmark for 60d87e7

Click to view benchmark
Test Base PR %
Array append evaluation 344.1±7.50µs 343.0±0.93µs -0.32%
Array literal evaluation 184.0±4.50µs 198.7±0.83µs +7.99%
Array update evaluation 426.9±7.69µs 425.0±2.22µs -0.45%
Core + Standard library compilation 17.0±0.27ms 17.0±0.34ms 0.00%
Deutsch-Jozsa evaluation 5.1±0.25ms 5.0±0.05ms -1.96%
Large file parity evaluation 33.8±0.13ms 33.9±0.58ms +0.30%
Large input file compilation 11.4±0.17ms 11.4±0.18ms 0.00%
Large input file compilation (interpreter) 45.1±1.35ms 45.4±1.81ms +0.67%
Large nested iteration 33.7±0.12ms 33.5±0.16ms -0.59%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1546.8±38.03µs 1550.8±39.29µs +0.26%
Perform Runtime Capabilities Analysis (RCA) on large file sample 7.6±0.06ms 7.9±0.28ms +3.95%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1411.9±37.19µs 1420.0±35.04µs +0.57%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 27.3±0.53ms 27.1±0.17ms -0.73%
Teleport evaluation 88.6±3.35µs 88.1±8.93µs -0.56%

Copy link

Benchmark for 03c8156

Click to view benchmark
Test Base PR %
Array append evaluation 341.9±2.35µs 344.4±2.49µs +0.73%
Array literal evaluation 180.4±1.65µs 203.6±10.30µs +12.86%
Array update evaluation 423.5±7.91µs 424.8±2.44µs +0.31%
Core + Standard library compilation 20.1±0.70ms 20.5±3.71ms +1.99%
Deutsch-Jozsa evaluation 5.1±0.05ms 5.1±0.06ms 0.00%
Large file parity evaluation 33.9±0.08ms 33.8±0.29ms -0.29%
Large input file compilation 12.5±0.36ms 12.4±0.47ms -0.80%
Large input file compilation (interpreter) 50.0±1.47ms 50.4±4.26ms +0.80%
Large nested iteration 33.5±0.71ms 33.7±0.29ms +0.60%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1623.2±183.09µs 1613.6±168.03µs -0.59%
Perform Runtime Capabilities Analysis (RCA) on large file sample 8.1±0.17ms 8.2±0.21ms +1.23%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1495.2±159.45µs 1475.2±122.49µs -1.34%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 28.6±0.67ms 28.6±1.10ms 0.00%
Teleport evaluation 89.3±3.75µs 88.6±3.44µs -0.78%

@DmitryVasilevsky DmitryVasilevsky added this pull request to the merge queue May 13, 2024
Merged via the queue into main with commit 2cb4aa0 May 13, 2024
15 of 16 checks passed
@DmitryVasilevsky DmitryVasilevsky deleted the dmitryv/docs-in-vscode branch May 13, 2024 20:25
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

4 participants