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

Fix docstring for Format::with_header in arrow-csv #6856

Merged
merged 1 commit into from
Dec 7, 2024

Conversation

kylebarron
Copy link
Contributor

Which issue does this PR close?

Closes #.

Rationale for this change

Fix documentation

What changes are included in this PR?

Format::header defaults to false but is documented as defaulting to true

/// The format specification for the CSV file
#[derive(Debug, Clone, Default)]
pub struct Format {
    header: bool,

Are there any user-facing changes?

No

@github-actions github-actions bot added the arrow Changes to the arrow crate label Dec 7, 2024
@kylebarron kylebarron changed the title Fix docstring for Format::with_header Fix docstring for Format::with_header in arrow-csv Dec 7, 2024
Copy link
Contributor

@alamb alamb 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 @kylebarron

Indeed the default is false

/// The format specification for the CSV file
#[derive(Debug, Clone, Default)]
pub struct Format {
    header: bool,
...

@alamb alamb added the documentation Improvements or additions to documentation label Dec 7, 2024
@alamb alamb merged commit 71c5d34 into apache:main Dec 7, 2024
24 checks passed
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.

2 participants