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

docs(examples): use ratatui::crossterm in examples #1315

Merged
merged 2 commits into from
Aug 11, 2024
Merged

Conversation

joshka
Copy link
Member

@joshka joshka commented Aug 10, 2024

We import from `ratatui::crossterm`` instead of crossterm directly in
the examples to ensure that the version of the crossterm crate used is
the same one as the one used by ratatui. This helps avoid compilation
errors resulting from multiple versions of the same crate.

Also avoids importing from the prelude in the examples.

@joshka joshka requested a review from a team as a code owner August 10, 2024 02:08
Copy link

github-actions bot commented Aug 10, 2024

🐰Bencher

ReportSat, August 10, 2024 at 03:46:05 UTC
ProjectRatatui
Branch1315/merge
Testbedubuntu-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-thresholds CLI flag.

Click to view all benchmark results
BenchmarkLatencyLatency Results
nanoseconds (ns)
barchart/render/2048➖ (view plot)202,360.00
barchart/render/256➖ (view plot)134,290.00
barchart/render/64➖ (view plot)88,005.00
barchart/render_grouped/2048➖ (view plot)348,980.00
barchart/render_grouped/256➖ (view plot)145,000.00
barchart/render_grouped/64➖ (view plot)133,770.00
barchart/render_horizontal/2048➖ (view plot)162,560.00
barchart/render_horizontal/256➖ (view plot)80,925.00
barchart/render_horizontal/64➖ (view plot)74,073.00
block/render_all_feature/100x50➖ (view plot)10,151.00
block/render_all_feature/200x50➖ (view plot)18,093.00
block/render_all_feature/256x256➖ (view plot)84,960.00
block/render_empty/100x50➖ (view plot)5,646.40
block/render_empty/200x50➖ (view plot)11,108.00
block/render_empty/256x256➖ (view plot)71,272.00
buffer/empty/16➖ (view plot)831.25
buffer/empty/255➖ (view plot)227,730.00
buffer/empty/64➖ (view plot)13,993.00
buffer/filled/16➖ (view plot)814.28
buffer/filled/255➖ (view plot)223,860.00
buffer/filled/64➖ (view plot)13,685.00
buffer/with_lines/16➖ (view plot)8,994.30
buffer/with_lines/255➖ (view plot)8,816.10
buffer/with_lines/64➖ (view plot)8,857.40
line_render/Center/0➖ (view plot)3.71
line_render/Center/10➖ (view plot)428.03
line_render/Center/3➖ (view plot)226.95
line_render/Center/4➖ (view plot)250.76
line_render/Center/42➖ (view plot)542.37
line_render/Center/6➖ (view plot)268.27
line_render/Center/7➖ (view plot)301.82
line_render/Left/0➖ (view plot)3.71
line_render/Left/10➖ (view plot)383.07
line_render/Left/3➖ (view plot)154.67
line_render/Left/4➖ (view plot)165.86
line_render/Left/42➖ (view plot)543.48
line_render/Left/6➖ (view plot)255.10
line_render/Left/7➖ (view plot)265.95
line_render/Right/0➖ (view plot)3.72
line_render/Right/10➖ (view plot)386.92
line_render/Right/3➖ (view plot)225.80
line_render/Right/4➖ (view plot)265.11
line_render/Right/42➖ (view plot)541.99
line_render/Right/6➖ (view plot)342.28
line_render/Right/7➖ (view plot)383.49
list/render/16384➖ (view plot)1,144,800.00
list/render/2048➖ (view plot)261,250.00
list/render/64➖ (view plot)141,380.00
list/render_scroll_half/16384➖ (view plot)1,142,400.00
list/render_scroll_half/2048➖ (view plot)267,470.00
list/render_scroll_half/64➖ (view plot)95,980.00
paragraph/new/2048➖ (view plot)248,850.00
paragraph/new/64➖ (view plot)6,659.30
paragraph/new/65535➖ (view plot)7,976,900.00
paragraph/render/2048➖ (view plot)439,850.00
paragraph/render/64➖ (view plot)400,480.00
paragraph/render/65535➖ (view plot)1,630,800.00
paragraph/render_scroll_full/2048➖ (view plot)392,520.00
paragraph/render_scroll_full/64➖ (view plot)428,000.00
paragraph/render_scroll_full/65535➖ (view plot)1,569,300.00
paragraph/render_scroll_half/2048➖ (view plot)389,670.00
paragraph/render_scroll_half/64➖ (view plot)433,910.00
paragraph/render_scroll_half/65535➖ (view plot)1,572,100.00
paragraph/render_wrap/2048➖ (view plot)215,580.00
paragraph/render_wrap/64➖ (view plot)181,430.00
paragraph/render_wrap/65535➖ (view plot)1,397,300.00
paragraph/render_wrap_scroll_full/2048➖ (view plot)214,540.00
paragraph/render_wrap_scroll_full/64➖ (view plot)181,750.00
paragraph/render_wrap_scroll_full/65535➖ (view plot)1,382,000.00
rect_rows/rows/1024➖ (view plot)322.51
rect_rows/rows/16➖ (view plot)5.25
rect_rows/rows/65535➖ (view plot)20,282.00
sparkline/render/2048➖ (view plot)126,980.00
sparkline/render/256➖ (view plot)119,540.00
sparkline/render/64➖ (view plot)38,124.00

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

We import from `ratatui::crossterm`` instead of crossterm directly in
the examples to ensure that the version of the crossterm crate used is
the same one as the one used by ratatui. This helps avoid compilation
errors resulting from multiple versions of the same crate.
@joshka joshka merged commit d5477b5 into main Aug 11, 2024
43 checks passed
@joshka joshka deleted the jm/examples-imports branch August 11, 2024 00:43
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.

2 participants