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: improve docs and add example for lexicographical_partition_ranges #4615

Merged
merged 3 commits into from
Aug 2, 2023

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Aug 1, 2023

Which issue does this PR close?

re #4575

Rationale for this change

While reviewing #4575 I wanted to make sure I really understood what was going on, so I made some pictures

What changes are included in this PR?

Add docstrings with ASCII art diagram and code example

Screenshot 2023-08-01 at 7 51 15 AM

Are there any user-facing changes?

docs

@github-actions github-actions bot added the arrow Changes to the arrow crate label Aug 1, 2023
Comment on lines +32 to +34
/// Returns an iterator with `k` items where `k` is cardinality of the
/// sort values: Consecutive values will be connected: `(a, b)` and `(b,
/// c)`, where `start = 0` and `end = n` for the first and last range.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// Returns an iterator with `k` items where `k` is cardinality of the
/// sort values: Consecutive values will be connected: `(a, b)` and `(b,
/// c)`, where `start = 0` and `end = n` for the first and last range.
/// Returns an iterator with `k` items where `k` is cardinality of the
/// sort values. Consecutive ranges will be contiguous: `(a, b)` and `(b,
/// c)`, where `start = 0` and `end = n` for the first and last range.

@tustvold tustvold merged commit 30a5b8d into apache:master Aug 2, 2023
16 checks passed
@alamb alamb deleted the alamb/partition_docs branch August 2, 2023 18:45
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.

2 participants