Skip to content

Add documentation and examples for pretty printing, make pretty_format_columns_with_options pub #7346

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

Merged
merged 3 commits into from
Mar 31, 2025

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Mar 27, 2025

Which issue does this PR close?

Rationale for this change

I have always wanted better documentation for the pretty format module so let's make some!

Also I was going to suggest that @blaginin add an example for #7335 but then I saw there were no examples to point at

What changes are included in this PR?

Add docs and examples to pretty printing code

Are there any user-facing changes?

  1. Documentation
  2. I also made pretty_format_columns_with_options pub to be consistent with the record batch API (this got flagged via tests)

@alamb alamb added the documentation Improvements or additions to documentation label Mar 27, 2025
@github-actions github-actions bot added the arrow Changes to the arrow crate label Mar 27, 2025
@alamb alamb force-pushed the alamb/pretty_print_examples branch from e3b4cc4 to 14f31b6 Compare March 27, 2025 16:34
@alamb alamb changed the title Add documentation and examples for pretty printing Add documentation and examples for pretty printing, make pretty_format_columns_with_options pub Mar 27, 2025
@alamb alamb marked this pull request as ready for review March 27, 2025 16:51
Copy link
Member

@waynexia waynexia left a comment

Choose a reason for hiding this comment

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

💯

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.

Nothing to nitpick 😅! Thanks!

Co-authored-by: Matthijs Brobbel <[email protected]>
@alamb alamb merged commit 5b44d67 into apache:main Mar 31, 2025
26 checks passed
@alamb alamb deleted the alamb/pretty_print_examples branch March 31, 2025 14:28
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 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants