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

VSCode shows documentation by package #1740

Merged
merged 15 commits into from
Aug 20, 2024
Merged

Conversation

DmitryVasilevsky
Copy link
Contributor

@DmitryVasilevsky DmitryVasilevsky commented Jul 15, 2024

Changed the way generated API documentation is shown in vscode. Also affects published documentation.

  • Items are sorted by package (current project first, then direct dependencies, then standard library, then core library), then by namespace, then by item name.
  • Fully qualified names are shown for items instead of just item names. Fully qualified names include package alias (if any), namespace and item name. For example, Length is shown as Microsoft.Quantum.Core.Length.
  • As namespace and package alias is now part of the title, a separate line with the namespace is removed.

This change does NOT address #1823

@DmitryVasilevsky DmitryVasilevsky marked this pull request as ready for review August 16, 2024 01:17
@DmitryVasilevsky DmitryVasilevsky requested review from sezna, ScottCarda-MS and cesarzc and removed request for billti and ScottCarda-MS August 16, 2024 01:17
Copy link

Benchmark for f63515a

Click to view benchmark
Test Base PR %
Array append evaluation 339.6±2.69µs 344.1±8.24µs +1.33%
Array literal evaluation 168.7±1.94µs 185.7±0.79µs +10.08%
Array update evaluation 418.1±6.61µs 418.9±1.49µs +0.19%
Core + Standard library compilation 23.1±0.49ms 23.0±0.45ms -0.43%
Deutsch-Jozsa evaluation 4.9±0.08ms 4.9±0.05ms 0.00%
Large file parity evaluation 34.2±0.10ms 34.2±0.35ms 0.00%
Large input file compilation 14.4±0.28ms 14.0±0.25ms -2.78%
Large input file compilation (interpreter) 55.0±1.64ms 54.5±1.88ms -0.91%
Large nested iteration 32.8±0.25ms 33.0±0.11ms +0.61%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1593.3±100.05µs 1568.9±54.32µs -1.53%
Perform Runtime Capabilities Analysis (RCA) on large file sample 8.1±0.11ms 8.1±0.11ms 0.00%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1449.8±98.22µs 1440.3±61.72µs -0.66%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 28.2±0.47ms 28.1±0.34ms -0.35%
Teleport evaluation 94.4±6.11µs 93.1±3.28µs -1.38%

Copy link

Benchmark for d501fce

Click to view benchmark
Test Base PR %
Array append evaluation 336.8±2.98µs 337.4±3.99µs +0.18%
Array literal evaluation 168.8±2.32µs 185.7±0.85µs +10.01%
Array update evaluation 413.9±4.46µs 414.8±2.00µs +0.22%
Core + Standard library compilation 22.3±0.57ms 23.7±1.26ms +6.28%
Deutsch-Jozsa evaluation 4.9±0.06ms 4.9±0.04ms 0.00%
Large file parity evaluation 34.0±0.23ms 34.2±0.68ms +0.59%
Large input file compilation 13.8±0.26ms 14.2±0.37ms +2.90%
Large input file compilation (interpreter) 53.1±2.01ms 54.8±2.72ms +3.20%
Large nested iteration 32.7±0.67ms 32.9±0.46ms +0.61%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1565.3±38.75µs 1576.9±84.83µs +0.74%
Perform Runtime Capabilities Analysis (RCA) on large file sample 8.0±0.14ms 8.0±0.30ms 0.00%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1422.6±41.52µs 1443.0±116.70µs +1.43%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 27.8±0.25ms 28.1±0.29ms +1.08%
Teleport evaluation 93.5±3.83µs 93.9±3.90µs +0.43%

compiler/qsc_doc_gen/src/generate_docs.rs Outdated Show resolved Hide resolved
compiler/qsc_doc_gen/src/generate_docs.rs Outdated Show resolved Hide resolved
compiler/qsc_doc_gen/src/generate_docs.rs Outdated Show resolved Hide resolved
@billti
Copy link
Member

billti commented Aug 16, 2024

Playing around with some sample projects, and I'm not sure we need the type to be part of the header (e.g. 'operation' or 'user defined type'). Especially as we show the definition immediately below the header anyway

image

@billti billti closed this Aug 16, 2024
@billti billti reopened this Aug 16, 2024
@billti
Copy link
Member

billti commented Aug 16, 2024

p.s. All the docs still use the Microsoft. namespace also. Where did we land on either adding or migrating to std for the docs? CC @sezna

Copy link

Benchmark for 8025aa4

Click to view benchmark
Test Base PR %
Array append evaluation 340.9±10.31µs 339.7±2.99µs -0.35%
Array literal evaluation 186.4±2.27µs 169.3±1.48µs -9.17%
Array update evaluation 420.0±26.72µs 415.6±2.78µs -1.05%
Core + Standard library compilation 22.8±1.06ms 22.9±0.91ms +0.44%
Deutsch-Jozsa evaluation 4.9±0.06ms 5.0±0.09ms +2.04%
Large file parity evaluation 34.3±0.14ms 34.4±0.67ms +0.29%
Large input file compilation 14.8±0.65ms 14.2±0.66ms -4.05%
Large input file compilation (interpreter) 54.5±1.80ms 52.0±2.35ms -4.59%
Large nested iteration 32.6±0.21ms 33.1±1.02ms +1.53%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1580.7±76.73µs 1569.9±71.15µs -0.68%
Perform Runtime Capabilities Analysis (RCA) on large file sample 7.9±0.21ms 7.9±0.10ms 0.00%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1436.6±65.16µs 1420.3±37.45µs -1.13%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 27.9±0.31ms 27.7±0.25ms -0.72%
Teleport evaluation 92.7±3.48µs 94.6±4.40µs +2.05%

Copy link

Benchmark for e1f4b8a

Click to view benchmark
Test Base PR %
Array append evaluation 338.3±3.41µs 338.0±2.14µs -0.09%
Array literal evaluation 169.1±1.02µs 186.0±0.93µs +9.99%
Array update evaluation 415.2±1.65µs 414.8±2.12µs -0.10%
Core + Standard library compilation 21.8±0.27ms 21.8±0.45ms 0.00%
Deutsch-Jozsa evaluation 4.9±0.06ms 4.9±0.18ms 0.00%
Large file parity evaluation 34.3±0.11ms 34.2±0.35ms -0.29%
Large input file compilation 13.7±0.15ms 14.5±1.70ms +5.84%
Large input file compilation (interpreter) 51.6±1.88ms 51.4±1.09ms -0.39%
Large nested iteration 32.9±0.28ms 32.8±0.18ms -0.30%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1555.0±29.84µs 1630.1±188.03µs +4.83%
Perform Runtime Capabilities Analysis (RCA) on large file sample 7.9±0.08ms 8.6±0.31ms +8.86%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1461.0±129.57µs 1427.3±52.14µs -2.31%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 27.8±0.64ms 27.8±0.40ms 0.00%
Teleport evaluation 93.6±3.55µs 92.8±3.84µs -0.85%

Copy link

Benchmark for fc2378b

Click to view benchmark
Test Base PR %
Array append evaluation 339.6±3.16µs 337.9±2.88µs -0.50%
Array literal evaluation 168.4±1.09µs 169.1±1.85µs +0.42%
Array update evaluation 416.8±6.24µs 416.0±4.97µs -0.19%
Core + Standard library compilation 24.6±0.78ms 24.5±0.83ms -0.41%
Deutsch-Jozsa evaluation 4.9±0.06ms 5.0±0.06ms +2.04%
Large file parity evaluation 34.5±0.36ms 34.4±0.19ms -0.29%
Large input file compilation 15.4±0.56ms 15.3±0.61ms -0.65%
Large input file compilation (interpreter) 57.1±1.78ms 56.9±1.94ms -0.35%
Large nested iteration 32.9±0.79ms 33.1±1.71ms +0.61%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 2.0±0.02ms 1617.1±132.56µs -19.14%
Perform Runtime Capabilities Analysis (RCA) on large file sample 8.8±0.22ms 8.4±0.18ms -4.55%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1911.9±95.62µs 1471.2±127.82µs -23.05%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 28.8±0.44ms 28.6±0.29ms -0.69%
Teleport evaluation 92.7±3.51µs 93.3±3.25µs +0.65%

Copy link

Benchmark for e02a6c0

Click to view benchmark
Test Base PR %
Array append evaluation 338.6±3.49µs 338.4±2.09µs -0.06%
Array literal evaluation 169.0±6.65µs 173.4±1.49µs +2.60%
Array update evaluation 417.2±14.72µs 416.4±5.45µs -0.19%
Core + Standard library compilation 24.5±0.85ms 25.1±1.07ms +2.45%
Deutsch-Jozsa evaluation 5.0±0.05ms 5.0±0.11ms 0.00%
Large file parity evaluation 34.3±0.11ms 34.5±2.20ms +0.58%
Large input file compilation 14.7±0.44ms 15.8±0.46ms +7.48%
Large input file compilation (interpreter) 56.4±2.34ms 59.6±1.63ms +5.67%
Large nested iteration 32.8±0.13ms 32.7±0.17ms -0.30%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1626.4±156.48µs 1580.4±68.12µs -2.83%
Perform Runtime Capabilities Analysis (RCA) on large file sample 8.4±0.34ms 8.0±0.15ms -4.76%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1464.6±102.73µs 1446.1±88.96µs -1.26%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 28.4±1.75ms 28.7±0.65ms +1.06%
Teleport evaluation 93.6±4.26µs 93.5±3.96µs -0.11%

Copy link

Benchmark for e691d21

Click to view benchmark
Test Base PR %
Array append evaluation 338.1±1.74µs 344.0±2.21µs +1.75%
Array literal evaluation 188.3±7.31µs 168.5±0.95µs -10.52%
Array update evaluation 416.7±2.67µs 421.6±4.09µs +1.18%
Core + Standard library compilation 21.7±0.06ms 21.6±0.10ms -0.46%
Deutsch-Jozsa evaluation 5.0±0.05ms 4.9±0.06ms -2.00%
Large file parity evaluation 34.2±0.15ms 34.2±0.26ms 0.00%
Large input file compilation 13.5±0.11ms 13.6±0.14ms +0.74%
Large input file compilation (interpreter) 50.1±0.85ms 50.4±1.28ms +0.60%
Large nested iteration 32.8±0.20ms 33.5±0.54ms +2.13%
Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample 1557.3±43.65µs 1557.3±37.90µs 0.00%
Perform Runtime Capabilities Analysis (RCA) on large file sample 7.8±0.12ms 7.9±0.09ms +1.28%
Perform Runtime Capabilities Analysis (RCA) on teleport sample 1419.2±28.99µs 1416.0±41.78µs -0.23%
Perform Runtime Capabilities Analysis (RCA) on the core and std libraries 27.5±0.20ms 27.6±0.23ms +0.36%
Teleport evaluation 92.8±3.38µs 91.7±3.63µs -1.19%

@DmitryVasilevsky DmitryVasilevsky added this pull request to the merge queue Aug 20, 2024
Merged via the queue into main with commit 69c74d2 Aug 20, 2024
19 checks passed
@DmitryVasilevsky DmitryVasilevsky deleted the dmitryv/doc-by-package branch August 20, 2024 21:17
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.

4 participants