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: update main lib.rs / README examples #1280

Merged
merged 1 commit into from
Aug 4, 2024
Merged

docs: update main lib.rs / README examples #1280

merged 1 commit into from
Aug 4, 2024

Conversation

joshka
Copy link
Member

@joshka joshka commented Aug 4, 2024

No description provided.

@joshka joshka requested a review from a team as a code owner August 4, 2024 11:41
Copy link
Contributor

@EdJoPaTo EdJoPaTo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we get rid of this duplication somehow? #[doc(include = "../README.md")] or something like that?

@joshka
Copy link
Member Author

joshka commented Aug 4, 2024

Can we get rid of this duplication somehow? #[doc(include = "../README.md")] or something like that?

No. The (majority of the) README is generated using cargo-rdme, which takes care of updating code links to point to correct web-urls etc.
This also means that this code is formatted by rustfmt.

Copy link

github-actions bot commented Aug 4, 2024

🐰Bencher

ReportSun, August 4, 2024 at 11:56:13 UTC
ProjectRatatui
Branch1280/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)175,210.00
barchart/render/256➖ (view plot)112,120.00
barchart/render/64➖ (view plot)69,755.00
barchart/render_grouped/2048➖ (view plot)319,420.00
barchart/render_grouped/256➖ (view plot)118,660.00
barchart/render_grouped/64➖ (view plot)106,980.00
barchart/render_horizontal/2048➖ (view plot)154,200.00
barchart/render_horizontal/256➖ (view plot)74,396.00
barchart/render_horizontal/64➖ (view plot)67,173.00
block/render_all_feature/100x50➖ (view plot)8,789.70
block/render_all_feature/200x50➖ (view plot)15,602.00
block/render_all_feature/256x256➖ (view plot)69,709.00
block/render_empty/100x50➖ (view plot)4,458.70
block/render_empty/200x50➖ (view plot)8,886.70
block/render_empty/256x256➖ (view plot)57,431.00
line_render/Center/0➖ (view plot)2.78
line_render/Center/10➖ (view plot)414.05
line_render/Center/3➖ (view plot)231.29
line_render/Center/4➖ (view plot)253.93
line_render/Center/42➖ (view plot)496.34
line_render/Center/6➖ (view plot)248.43
line_render/Center/7➖ (view plot)277.01
line_render/Left/0➖ (view plot)2.78
line_render/Left/10➖ (view plot)352.16
line_render/Left/3➖ (view plot)144.26
line_render/Left/4➖ (view plot)151.39
line_render/Left/42➖ (view plot)496.94
line_render/Left/6➖ (view plot)233.77
line_render/Left/7➖ (view plot)242.03
line_render/Right/0➖ (view plot)2.78
line_render/Right/10➖ (view plot)376.18
line_render/Right/3➖ (view plot)218.18
line_render/Right/4➖ (view plot)255.04
line_render/Right/42➖ (view plot)496.15
line_render/Right/6➖ (view plot)327.41
line_render/Right/7➖ (view plot)364.36
list/render/16384➖ (view plot)1,128,800.00
list/render/2048➖ (view plot)249,050.00
list/render/64➖ (view plot)131,740.00
list/render_scroll_half/16384➖ (view plot)1,132,000.00
list/render_scroll_half/2048➖ (view plot)252,650.00
list/render_scroll_half/64➖ (view plot)89,720.00
paragraph/new/2048➖ (view plot)250,370.00
paragraph/new/64➖ (view plot)6,071.20
paragraph/new/65535➖ (view plot)14,065,000.00
paragraph/render/2048➖ (view plot)430,020.00
paragraph/render/64➖ (view plot)393,120.00
paragraph/render/65535➖ (view plot)1,503,000.00
paragraph/render_scroll_full/2048➖ (view plot)385,990.00
paragraph/render_scroll_full/64➖ (view plot)414,250.00
paragraph/render_scroll_full/65535➖ (view plot)1,459,200.00
paragraph/render_scroll_half/2048➖ (view plot)387,320.00
paragraph/render_scroll_half/64➖ (view plot)419,890.00
paragraph/render_scroll_half/65535➖ (view plot)1,456,800.00
paragraph/render_wrap/2048➖ (view plot)215,410.00
paragraph/render_wrap/64➖ (view plot)187,780.00
paragraph/render_wrap/65535➖ (view plot)1,385,200.00
paragraph/render_wrap_scroll_full/2048➖ (view plot)213,500.00
paragraph/render_wrap_scroll_full/64➖ (view plot)187,600.00
paragraph/render_wrap_scroll_full/65535➖ (view plot)1,404,100.00
sparkline/render/2048➖ (view plot)112,960.00
sparkline/render/256➖ (view plot)112,000.00
sparkline/render/64➖ (view plot)36,056.00

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

@joshka joshka merged commit f775030 into main Aug 4, 2024
38 checks passed
@joshka joshka deleted the jm/readme branch August 4, 2024 12:09
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants