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 arrow-flight docs #3372

Merged
merged 3 commits into from
Dec 20, 2022
Merged

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Dec 19, 2022

Which issue does this PR close?

Related to flightsql: #3301

Rationale for this change

I want to make this crate easier to understand and navigate, especially as we add features like FlightSQL

What changes are included in this PR?

Improve some docstrings and the readme

Are there any user-facing changes?

Docs

@alamb alamb added the documentation Improvements or additions to documentation label Dec 19, 2022
@github-actions github-actions bot added the arrow-flight Changes to the arrow-flight crate label Dec 19, 2022
@github-actions github-actions bot added the arrow Changes to the arrow crate label Dec 20, 2022
arrow-flight/src/lib.rs Outdated Show resolved Hide resolved
Co-authored-by: Raphael Taylor-Davies <1781103+tustvold@users.noreply.github.com>
@tustvold tustvold merged commit e89b043 into apache:master Dec 20, 2022
@ursabot
Copy link

ursabot commented Dec 21, 2022

Benchmark runs are scheduled for baseline = a8968cd and contender = e89b043. e89b043 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

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 arrow-flight Changes to the arrow-flight crate documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants