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

Add some doc comments to parquet bit_util #663

Merged
merged 1 commit into from
Aug 8, 2021

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Aug 5, 2021

Rationale for this change

I had to double check a few times what units (bits or bytes) were used for some functions in bit_utils.rs while reviewing #658

What changes are included in this PR?

Encode units in doc comments

@alamb alamb changed the title Add some do comments to parquet bit_util Add some doc comments to parquet bit_util Aug 5, 2021
@github-actions github-actions bot added the parquet Changes to the parquet crate label Aug 5, 2021
@codecov-commenter
Copy link

Codecov Report

Merging #663 (65d02af) into master (6bf1988) will decrease coverage by 0.07%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #663      +/-   ##
==========================================
- Coverage   82.50%   82.42%   -0.08%     
==========================================
  Files         168      168              
  Lines       47249    47250       +1     
==========================================
- Hits        38984    38948      -36     
- Misses       8265     8302      +37     
Impacted Files Coverage Δ
parquet/src/util/bit_util.rs 93.14% <ø> (ø)
arrow/src/array/transform/boolean.rs 76.92% <0.00%> (-7.70%) ⬇️
arrow/src/array/transform/utils.rs 95.00% <0.00%> (-5.00%) ⬇️
arrow/src/array/equal_json.rs 85.21% <0.00%> (-3.48%) ⬇️
arrow/src/tensor.rs 85.00% <0.00%> (-2.50%) ⬇️
parquet/src/column/page.rs 97.36% <0.00%> (-1.32%) ⬇️
arrow/src/array/equal/utils.rs 74.00% <0.00%> (-1.00%) ⬇️
parquet/src/record/api.rs 91.60% <0.00%> (-0.88%) ⬇️
parquet/src/file/statistics.rs 93.80% <0.00%> (-0.83%) ⬇️
arrow/src/csv/writer.rs 82.41% <0.00%> (-0.74%) ⬇️
... and 16 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6bf1988...65d02af. Read the comment docs.

@alamb alamb merged commit 7b2e26d into apache:master Aug 8, 2021
@alamb alamb deleted the alamb/comments branch August 8, 2021 10:36
alamb added a commit that referenced this pull request Aug 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
parquet Changes to the parquet crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants