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

DRY up docs/README #4

Merged
merged 4 commits into from
Apr 10, 2024
Merged

DRY up docs/README #4

merged 4 commits into from
Apr 10, 2024

Conversation

virtualritz
Copy link
Contributor

What I suggested after the last PR was closed: I condensed the integer arithmetic backend docs with the cargo features section and added your benchmarks table. I think it's much easier to grok than reading the % behind each feature. 😁
Misses ibig timings though.

On that note docs.rs and crates.io have full Smartypants support, i.e. -- and --- get turned into resp. unicode n and m dashes during conversion, But GH has not. So the README doesn't render as nice here.
I think that's acceptable, use e.g. inlyne. 😉

Copy link
Owner

@yuyttenhove yuyttenhove left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks!

I moved the benchmark to an example (instead of running a test) and updated the results in the documentation.

@yuyttenhove yuyttenhove merged commit e807f39 into yuyttenhove:master Apr 10, 2024
1 check passed
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