search

microsoft / qsharp

Azure Quantum Development Kit, including the Q# programming language, resource estimator, and Quantum Katas
https://microsoft.github.io/qsharp/
MIT License
367 stars 73 forks source link

Improve linter documentation #1650

Closed orpuente-MS closed 1 week ago

orpuente-MS commented 1 week ago

This PR doesn't change any code. It adds a new docstring to improve the experience of a contributor adding a new lint.

It also fixes an error in the crate-level documentation.

github-actions[bot] commented 1 week ago

Benchmark for f47720f

Click to view benchmark | Test | Base | PR | % | |------|--------------|------------------|---| | Array append evaluation | 328.9±4.48µs | 326.8±3.04µs | -0.64% | | Array literal evaluation | 174.2±0.78µs | 174.7±1.23µs | +0.29% | | Array update evaluation | 407.7±10.25µs | 406.4±1.44µs | -0.32% | | Core + Standard library compilation | 20.2±0.18ms | 20.1±0.10ms | -0.50% | | Deutsch-Jozsa evaluation | 5.1±0.07ms | 5.1±0.10ms | 0.00% | | Large file parity evaluation | 34.2±0.08ms | 34.2±0.40ms | 0.00% | | Large input file compilation | 12.7±0.24ms | **12.5±0.09ms** | **-1.57%** | | Large input file compilation (interpreter) | 47.7±0.87ms | 47.6±0.88ms | -0.21% | | Large nested iteration | 32.6±0.82ms | 33.1±1.25ms | +1.53% | | Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample | 1561.3±30.61µs | 1564.0±36.03µs | +0.17% | | Perform Runtime Capabilities Analysis (RCA) on large file sample | 7.8±0.13ms | 7.8±0.11ms | 0.00% | | Perform Runtime Capabilities Analysis (RCA) on teleport sample | 1423.0±39.40µs | 1419.1±26.23µs | -0.27% | | Perform Runtime Capabilities Analysis (RCA) on the core and std libraries | 28.1±0.26ms | 28.1±0.17ms | 0.00% | | Teleport evaluation | 89.6±4.06µs | 89.7±5.27µs | +0.11% |
github-actions[bot] commented 1 week ago

Benchmark for ad064f2

Click to view benchmark | Test | Base | PR | % | |------|--------------|------------------|---| | Array append evaluation | 327.0±9.27µs | **321.7±1.59µs** | **-1.62%** | | Array literal evaluation | **192.1±0.67µs** | 193.6±3.26µs | **+0.78%** | | Array update evaluation | 408.2±4.68µs | **402.2±1.76µs** | **-1.47%** | | Core + Standard library compilation | 21.3±0.90ms | 21.9±1.17ms | +2.82% | | Deutsch-Jozsa evaluation | 5.1±0.21ms | 5.1±0.20ms | 0.00% | | Large file parity evaluation | **34.2±0.08ms** | 34.4±1.15ms | **+0.58%** | | Large input file compilation | 13.2±0.41ms | 13.5±0.72ms | +2.27% | | Large input file compilation (interpreter) | 52.7±2.53ms | 51.9±1.48ms | -1.52% | | Large nested iteration | 32.2±0.18ms | 32.2±1.05ms | 0.00% | | Perform Runtime Capabilities Analysis (RCA) on Deutsch-Jozsa sample | 1585.7±72.16µs | 1578.1±85.55µs | -0.48% | | Perform Runtime Capabilities Analysis (RCA) on large file sample | 8.0±0.12ms | 7.9±0.15ms | -1.25% | | Perform Runtime Capabilities Analysis (RCA) on teleport sample | 1435.6±66.40µs | 1445.7±135.49µs | +0.70% | | Perform Runtime Capabilities Analysis (RCA) on the core and std libraries | 28.6±0.30ms | 28.6±0.48ms | 0.00% | | Teleport evaluation | 89.7±5.91µs | 89.7±3.55µs | 0.00% |