Skip to content

Minor: Add diagrams and documentation to row format#3094

Merged
tustvold merged 2 commits into
apache:masterfrom
alamb:alamb/docs_and_diagrams
Nov 13, 2022
Merged

Minor: Add diagrams and documentation to row format#3094
tustvold merged 2 commits into
apache:masterfrom
alamb:alamb/docs_and_diagrams

Conversation

@alamb

@alamb alamb commented Nov 12, 2022

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

N/A

Rationale for this change

We spent the time making the content for the blog, and now I want to put it closer to the code so it might be found more easily as well as kept up to date.

What changes are included in this PR?

Move relevant content from blogs to docstrings

https://arrow.apache.org/blog/2022/11/07/multi-column-sorts-in-arrow-rust-part-1/
https://arrow.apache.org/blog/2022/11/07/multi-column-sorts-in-arrow-rust-part-2/

Are there any user-facing changes?

More ASCII art in the docstrings

@github-actions github-actions Bot added the arrow Changes to the arrow crate label Nov 12, 2022
Comment thread arrow/src/row/mod.rs
///
/// The order of a given column can be reversed by negating the encoded bytes of non-null values
///
/// [COBS]:[https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing]

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

these links didn't work correctly when I was testing them locally

@tustvold tustvold merged commit c7210ce into apache:master Nov 13, 2022
@ursabot

ursabot commented Nov 13, 2022

Copy link
Copy Markdown

Benchmark runs are scheduled for baseline = aaf030f and contender = c7210ce. c7210ce is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on ec2-t3-xlarge-us-east-2] ec2-t3-xlarge-us-east-2
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on test-mac-arm] test-mac-arm
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on ursa-i9-9960x] ursa-i9-9960x
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on ursa-thinkcentre-m75q] ursa-thinkcentre-m75q
Buildkite builds:
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

@tustvold tustvold mentioned this pull request Nov 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

arrow Changes to the arrow crate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants