chore(ci): use cargo-docs-rs to lint docs #1318
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
c8d8dff to
001d09a
Compare
001d09a to
ba9a961
Compare
|
| Report | Sun, August 11, 2024 at 19:26:52 UTC |
| Project | Ratatui |
| Branch | 1318/merge |
| Testbed | ubuntu-latest |
⚠️ WARNING: The following Measure does not have a Threshold. Without a Threshold, no Alerts will ever be generated!
- Latency (latency)
Click here to create a new Threshold
For more information, see the Threshold documentation.
To only post results if a Threshold exists, set the--ci-only-thresholdsCLI flag.
Click to view all benchmark results
| Benchmark | Latency | Latency Results nanoseconds (ns) |
|---|---|---|
| barchart/render/2048 | ➖ (view plot) | 203,910.00 |
| barchart/render/256 | ➖ (view plot) | 135,370.00 |
| barchart/render/64 | ➖ (view plot) | 88,613.00 |
| barchart/render_grouped/2048 | ➖ (view plot) | 351,390.00 |
| barchart/render_grouped/256 | ➖ (view plot) | 147,330.00 |
| barchart/render_grouped/64 | ➖ (view plot) | 133,660.00 |
| barchart/render_horizontal/2048 | ➖ (view plot) | 161,730.00 |
| barchart/render_horizontal/256 | ➖ (view plot) | 81,423.00 |
| barchart/render_horizontal/64 | ➖ (view plot) | 75,388.00 |
| block/render_all_feature/100x50 | ➖ (view plot) | 10,175.00 |
| block/render_all_feature/200x50 | ➖ (view plot) | 18,381.00 |
| block/render_all_feature/256x256 | ➖ (view plot) | 85,330.00 |
| block/render_empty/100x50 | ➖ (view plot) | 5,615.00 |
| block/render_empty/200x50 | ➖ (view plot) | 11,214.00 |
| block/render_empty/256x256 | ➖ (view plot) | 71,922.00 |
| buffer/empty/16 | ➖ (view plot) | 829.11 |
| buffer/empty/255 | ➖ (view plot) | 228,270.00 |
| buffer/empty/64 | ➖ (view plot) | 14,114.00 |
| buffer/filled/16 | ➖ (view plot) | 843.86 |
| buffer/filled/255 | ➖ (view plot) | 221,870.00 |
| buffer/filled/64 | ➖ (view plot) | 13,820.00 |
| buffer/with_lines/16 | ➖ (view plot) | 8,987.80 |
| buffer/with_lines/255 | ➖ (view plot) | 9,422.50 |
| buffer/with_lines/64 | ➖ (view plot) | 9,581.00 |
| line_render/Center/0 | ➖ (view plot) | 3.71 |
| line_render/Center/10 | ➖ (view plot) | 462.92 |
| line_render/Center/3 | ➖ (view plot) | 239.69 |
| line_render/Center/4 | ➖ (view plot) | 268.30 |
| line_render/Center/42 | ➖ (view plot) | 584.96 |
| line_render/Center/6 | ➖ (view plot) | 296.00 |
| line_render/Center/7 | ➖ (view plot) | 337.08 |
| line_render/Left/0 | ➖ (view plot) | 3.71 |
| line_render/Left/10 | ➖ (view plot) | 422.83 |
| line_render/Left/3 | ➖ (view plot) | 155.37 |
| line_render/Left/4 | ➖ (view plot) | 166.41 |
| line_render/Left/42 | ➖ (view plot) | 585.71 |
| line_render/Left/6 | ➖ (view plot) | 273.18 |
| line_render/Left/7 | ➖ (view plot) | 281.50 |
| line_render/Right/0 | ➖ (view plot) | 3.71 |
| line_render/Right/10 | ➖ (view plot) | 398.58 |
| line_render/Right/3 | ➖ (view plot) | 217.53 |
| line_render/Right/4 | ➖ (view plot) | 256.06 |
| line_render/Right/42 | ➖ (view plot) | 584.36 |
| line_render/Right/6 | ➖ (view plot) | 332.03 |
| line_render/Right/7 | ➖ (view plot) | 373.27 |
| list/render/16384 | ➖ (view plot) | 1,150,400.00 |
| list/render/2048 | ➖ (view plot) | 262,680.00 |
| list/render/64 | ➖ (view plot) | 141,950.00 |
| list/render_scroll_half/16384 | ➖ (view plot) | 1,141,800.00 |
| list/render_scroll_half/2048 | ➖ (view plot) | 267,610.00 |
| list/render_scroll_half/64 | ➖ (view plot) | 97,428.00 |
| paragraph/new/2048 | ➖ (view plot) | 249,800.00 |
| paragraph/new/64 | ➖ (view plot) | 6,543.90 |
| paragraph/new/65535 | ➖ (view plot) | 8,161,200.00 |
| paragraph/render/2048 | ➖ (view plot) | 437,690.00 |
| paragraph/render/64 | ➖ (view plot) | 398,990.00 |
| paragraph/render/65535 | ➖ (view plot) | 1,631,600.00 |
| paragraph/render_scroll_full/2048 | ➖ (view plot) | 393,000.00 |
| paragraph/render_scroll_full/64 | ➖ (view plot) | 421,200.00 |
| paragraph/render_scroll_full/65535 | ➖ (view plot) | 1,586,200.00 |
| paragraph/render_scroll_half/2048 | ➖ (view plot) | 392,480.00 |
| paragraph/render_scroll_half/64 | ➖ (view plot) | 426,900.00 |
| paragraph/render_scroll_half/65535 | ➖ (view plot) | 1,577,500.00 |
| paragraph/render_wrap/2048 | ➖ (view plot) | 225,420.00 |
| paragraph/render_wrap/64 | ➖ (view plot) | 178,370.00 |
| paragraph/render_wrap/65535 | ➖ (view plot) | 1,403,300.00 |
| paragraph/render_wrap_scroll_full/2048 | ➖ (view plot) | 226,040.00 |
| paragraph/render_wrap_scroll_full/64 | ➖ (view plot) | 179,290.00 |
| paragraph/render_wrap_scroll_full/65535 | ➖ (view plot) | 1,417,500.00 |
| rect_rows/rows/1024 | ➖ (view plot) | 322.72 |
| rect_rows/rows/16 | ➖ (view plot) | 5.24 |
| rect_rows/rows/65535 | ➖ (view plot) | 20,286.00 |
| sparkline/render/2048 | ➖ (view plot) | 120,960.00 |
| sparkline/render/256 | ➖ (view plot) | 122,820.00 |
| sparkline/render/64 | ➖ (view plot) | 38,339.00 |
Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help
orhun
approved these changes
Aug 11, 2024
|
Out of curiosity, can you give an example of a (edge) case we can catch with this CI check? |
|
Anything that is doc specific. E.g.: the following mismatched code fence: //! ```
//! ``
Or a link to a non-existent item: /// [`foo`]
https://doc.rust-lang.org/rustdoc/lints.html has the lints. We use nightly for docs because we like several of the features that are only available in nightly
Switching to cargo-docs-rs over our custom params means that we don't have to track the exact params that docs-rs will use to build our docs, which means that the CI tests the same thing that will be eventually deployed. |
|
Got it, thanks for the example 👍🏼 |
joshka
added a commit
to erak/ratatui
that referenced
this pull request
Oct 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.