Skip to content

Conversation

@alamb
Copy link
Contributor

@alamb alamb commented Mar 22, 2025

Which issue does this PR close?

Rationale for this change

I spent a while looking for how to write parquet data with multiple threads and I knew the functionality exists

Also I always get confused looking at the parquet documentation as there are similarly named structures and in different modules.

What changes are included in this PR?

Let's leave some more links in the docs to make it easier to APIs related to parallelism

Also, mention in the key structures crate level docs

Are there any user-facing changes?

Documentation only.

There are no functional changes

@alamb
Copy link
Contributor Author

alamb commented Mar 22, 2025

I have a few more things to write but ran out of time today

@github-actions github-actions bot added the parquet Changes to the parquet crate label Mar 22, 2025
@alamb alamb force-pushed the alamb/parallel-docs branch from 6a8012a to 9026cc0 Compare March 23, 2025 18:46
@alamb alamb changed the title Add documentation on writing parquet with multiple threads Improve documentation on writing parquet, including multiple threads Mar 23, 2025
@alamb alamb force-pushed the alamb/parallel-docs branch from 9026cc0 to 1e5e072 Compare March 23, 2025 18:54
@alamb alamb added the documentation Improvements or additions to documentation label Mar 23, 2025
@alamb alamb marked this pull request as ready for review March 23, 2025 19:09
@alamb alamb requested a review from etseidl March 25, 2025 17:42
@alamb
Copy link
Contributor Author

alamb commented Mar 25, 2025

@etseidl I wonder if I could trouble you for a review of this PR?

Copy link
Contributor

@etseidl etseidl left a comment

Choose a reason for hiding this comment

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

Another nice improvement, thanks @alamb.

Comment on lines 59 to 60
//! to leverage the wide range of data transforms provided by the [arrow] crate, the
//! ecosystem of [Arrow] compatible systems.
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure why you dropped "and by" here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think I was exercising my inner copy editor and trying to reduce the number of words being used to express this concept. I agree and by was a unintended casualty. I will put it back

@alamb alamb merged commit ac00928 into apache:main Mar 26, 2025
16 checks passed
@alamb
Copy link
Contributor Author

alamb commented Mar 26, 2025

Thanks again @etseidl

@alamb alamb deleted the alamb/parallel-docs branch March 26, 2025 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation parquet Changes to the parquet crate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants