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.

Sign up for GitHub

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

Jump to bottom

Rephrase doc comment #6421

Merged
merged 6 commits into from
Sep 19, 2024
Merged

Rephrase doc comment #6421

merged 6 commits into from
Sep 19, 2024

Conversation

waynexia
Copy link
Member

Which issue does this PR close?

Follow up of #6348

Rationale for this change

This PR fixes too_long_first_doc_paragraph. It's just some wordplay and doesn't contain logic change.

What changes are included in this PR?

Rephrase doc comment to keep the first paragraph short. Comparison:

before after
image image

Are there any user-facing changes?

@waynexia
docs: rephase some
589ec20 
Signed-off-by: Ruihang Xia <waynestxia@gmail.com>
@waynexia
fix all warnings
274b409 
Signed-off-by: Ruihang Xia <waynestxia@gmail.com>
@waynexia
big letter at the beginning
fac0760 
Signed-off-by: Ruihang Xia <waynestxia@gmail.com>
@github-actions github-actions bot added parquet Changes to the parquet crate arrow Changes to the arrow crate arrow-flight Changes to the arrow-flight crate parquet-derive labels Sep 19, 2024
Xuanwo
Xuanwo approved these changes Sep 19, 2024
View reviewed changes
Copy link
Member

@Xuanwo Xuanwo left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thank you for working on this! (Simple changes, worth a quick merge.)

@waynexia
Copy link
Member Author

We can consider adding some nightly clippy checks in CI like https://github.com/apache/arrow-rs/pull/6336/files#diff-19251f16d3ccc5e26448a7cff24bc062c81ee68bac2547dd60dd481f14d437f3R202-R216 after this patch.

tustvold
tustvold approved these changes Sep 19, 2024
View reviewed changes
Copy link
Contributor

@tustvold tustvold left a comment

Choose a reason for hiding this comment

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

Thank you, just some minor nits

arrow-arith/src/arity.rs Outdated Show resolved Hide resolved
arrow-arith/src/arity.rs Outdated Show resolved Hide resolved
arrow-array/src/types.rs Outdated Show resolved Hide resolved
arrow/src/pyarrow.rs Outdated Show resolved Hide resolved
parquet/src/record/record_writer.rs Outdated Show resolved Hide resolved
waynexia and others added 2 commits September 19, 2024 15:36
@waynexia @tustvold
Apply suggestions from code review
a17de97 
Co-authored-by: Raphael Taylor-Davies <1781103+tustvold@users.noreply.github.com>
@waynexia @tustvold
Update arrow/src/pyarrow.rs
aef5487 
Co-authored-by: Raphael Taylor-Davies <1781103+tustvold@users.noreply.github.com>
@waynexia
Copy link
Member Author

Thanks for reviewing this @Xuanwo @tustvold ❤️

mbrobbel
mbrobbel reviewed Sep 19, 2024
View reviewed changes
arrow-array/src/types.rs Outdated Show resolved Hide resolved
@waynexia @mbrobbel
Update arrow-array/src/types.rs
144354a 
Co-authored-by: Matthijs Brobbel <m1brobbel@gmail.com>
@tustvold tustvold merged commit 1390283 into apache:master Sep 19, 2024
28 checks passed
@alamb alamb added the documentation Improvements or additions to documentation label Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mbrobbel mbrobbel mbrobbel left review comments

@Xuanwo Xuanwo Xuanwo approved these changes

@tustvold tustvold tustvold approved these changes

Assignees
No one assigned
Labels
arrow Changes to the arrow crate arrow-flight Changes to the arrow-flight crate documentation Improvements or additions to documentation parquet Changes to the parquet crate parquet-derive
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@waynexia @tustvold @Xuanwo @mbrobbel @alamb