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

[MINOR]: Add documentation to datafusion-row modules #2704

Merged
merged 5 commits into from
Jun 6, 2022

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Jun 6, 2022

Rationale:

I am working on writing up more detail on various next steps for the RowFormat on #1861 and found myself reading the code to understand what was going on better. I have encoded various thoughts into docstrings so hopefully future readers will find the code easier to navigate.

Changes:

  • Add / move docstrings
  • No code change

cc @yjshen

Copy link
Member

@yjshen yjshen left a comment

Choose a reason for hiding this comment

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

Great writing and nice diagrams. Thanks @alamb!

@codecov-commenter
Copy link

Codecov Report

Merging #2704 (6543d75) into master (bbb674a) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2704   +/-   ##
=======================================
  Coverage   84.66%   84.66%           
=======================================
  Files         270      270           
  Lines       46919    46919           
=======================================
+ Hits        39723    39726    +3     
+ Misses       7196     7193    -3     
Impacted Files Coverage Δ
datafusion/row/src/accessor.rs 56.41% <ø> (ø)
datafusion/row/src/layout.rs 98.27% <ø> (ø)
datafusion/row/src/lib.rs 100.00% <ø> (ø)
datafusion/row/src/reader.rs 88.27% <ø> (ø)
datafusion/row/src/writer.rs 89.86% <ø> (ø)
datafusion/optimizer/src/utils.rs 32.25% <0.00%> (-0.54%) ⬇️
datafusion/core/src/physical_plan/metrics/value.rs 86.93% <0.00%> (-0.51%) ⬇️
datafusion/common/src/scalar.rs 74.94% <0.00%> (+0.11%) ⬆️
datafusion/expr/src/logical_plan/plan.rs 74.75% <0.00%> (+0.59%) ⬆️
datafusion/expr/src/window_frame.rs 93.27% <0.00%> (+0.84%) ⬆️

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 bbb674a...6543d75. Read the comment docs.

@alamb alamb merged commit 3cd62e9 into apache:master Jun 6, 2022
@alamb alamb deleted the alamb/row_documentation branch August 8, 2023 20:13
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.

5 participants