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: Polish docs for Operator, Reader and Writer #5516

Merged
merged 1 commit into from
Jan 7, 2025
Merged

Conversation

Xuanwo
Copy link
Member

@Xuanwo Xuanwo commented Jan 7, 2025

Which issue does this PR close?

None.

Rationale for this change

Make user happy about our public API.

What changes are included in this PR?

Docs for all options provided by opendal Reader and Writer.

Are there any user-facing changes?

API Docs

Copy link

codspeed-hq bot commented Jan 7, 2025

CodSpeed Performance Report

Merging #5516 will degrade performances by 15.89%

Comparing polish-docs (c3bb036) with main (6ca3eab)

Summary

⚡ 8 improvements
❌ 4 regressions
✅ 61 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

Benchmark main polish-docs Change
buffer 256 KiB * 32 chunk 154.4 ns 183.6 ns -15.89%
buffer 256 KiB * 4 chunk 154.4 ns 183.6 ns -15.89%
buffer 4.00 MiB * 32 chunk 154.4 ns 183.6 ns -15.89%
buffer 4.00 MiB * 4 chunk 154.4 ns 183.6 ns -15.89%
256 KiB * 1000k chunk 183.6 ns 154.4 ns +18.88%
256 KiB * 1000k truncate 245.8 ns 216.7 ns +13.46%
256 KiB * 100k chunk 183.6 ns 154.4 ns +18.88%
256 KiB * 100k truncate 245.8 ns 216.7 ns +13.46%
256 KiB * 10k chunk 183.6 ns 154.4 ns +18.88%
256 KiB * 10k truncate 245.8 ns 216.7 ns +13.46%
256 KiB * 1k chunk 212.8 ns 183.6 ns +15.89%
256 KiB * 1k truncate 245.8 ns 216.7 ns +13.46%

@Xuanwo Xuanwo merged commit b84172e into main Jan 7, 2025
277 checks passed
@Xuanwo Xuanwo deleted the polish-docs branch January 7, 2025 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants