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

Fix default init_buffer_size to be 512 KiB #112

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

jkalez
Copy link
Contributor

@jkalez jkalez commented Nov 25, 2024

The docs specify that init_buffer_size's default value is 512 KiB. However it's actually 512 MiB (512 * 1024 * 1024 == 512 MiB). This PR updates the docs. An alternative approach could be to change the default; I'm not sure which is better.

@inflation
Copy link
Owner

It's probably a mistake of the code. I would keep it at 512 KiB or 1 MiB for the default value.

@jkalez jkalez changed the title Fixup documentation to accurately reflect init_buffer_size's default Fix default init_buffer_size to be 512 KiB Nov 26, 2024
@jkalez
Copy link
Contributor Author

jkalez commented Nov 26, 2024

Changed the PR to change the default init_buffer_size instead of changing the documentation

Copy link

codecov bot commented Nov 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.23%. Comparing base (0444c91) to head (63d856b).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #112   +/-   ##
=======================================
  Coverage   98.23%   98.23%           
=======================================
  Files          15       15           
  Lines         849      849           
=======================================
  Hits          834      834           
  Misses         15       15           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@inflation inflation merged commit b35ee4f into inflation:master Nov 27, 2024
11 checks 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