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

docs(python): Fix infer_schema_length param description #14233

Merged
merged 4 commits into from
Feb 16, 2024
Merged

docs(python): Fix infer_schema_length param description #14233

merged 4 commits into from
Feb 16, 2024

Conversation

FBruzzesi
Copy link
Contributor

@FBruzzesi FBruzzesi commented Feb 3, 2024 •
edited by stinodego
Loading

Description

Fixes #14232 by:

  • Fixing default value
  • Adding description for None case

@FBruzzesi FBruzzesi changed the title infer_schema_length param description docs(python): infer_schema_length param description Feb 3, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Feb 3, 2024
@enchant3dmango
Copy link

@FBruzzesi where does the N_INFER_DEFAULT value come from?

@FBruzzesi
Copy link
Contributor Author

FBruzzesi commented Feb 6, 2024 •
edited
Loading

@FBruzzesi where does the N_INFER_DEFAULT value come from?

That is defined in py-polars/polars/datatypes/constants.py and then imported in the other modules.
The comment on the variable states:

number of rows to scan by default when inferring datatypes

stinodego
stinodego requested changes Feb 15, 2024
View reviewed changes
Copy link
Member

@stinodego stinodego left a comment

Choose a reason for hiding this comment

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

Could you finish this PR and set it to "ready for review"?

py-polars/polars/dataframe/frame.py Outdated Show resolved Hide resolved
@FBruzzesi FBruzzesi marked this pull request as ready for review February 15, 2024 22:17
@stinodego stinodego force-pushed the docs/14232-infer-schema-length-description branch from 2cc7855 to 1d2bb09 Compare February 16, 2024 11:49
stinodego
stinodego approved these changes Feb 16, 2024
View reviewed changes
Copy link
Member

@stinodego stinodego left a comment

Choose a reason for hiding this comment

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

Thanks! I took the opportunity to improve the wording of the related docs and address the issue that the default was not using the constant everywhere.

@stinodego stinodego changed the title docs(python): infer_schema_length param description docs(python): Fix infer_schema_length param description Feb 16, 2024
@stinodego stinodego merged commit a4921bb into pola-rs:main Feb 16, 2024
13 checks passed
@FBruzzesi FBruzzesi deleted the docs/14232-infer-schema-length-description branch February 16, 2024 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stinodego stinodego stinodego approved these changes

@ritchie46 ritchie46 Awaiting requested review from ritchie46 ritchie46 is a code owner

@c-peters c-peters Awaiting requested review from c-peters c-peters is a code owner

@alexander-beedie alexander-beedie Awaiting requested review from alexander-beedie alexander-beedie is a code owner

@MarcoGorelli MarcoGorelli Awaiting requested review from MarcoGorelli MarcoGorelli is a code owner

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation python Related to Python Polars
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

infer_schema_length description is uncomplete
3 participants
@FBruzzesi @enchant3dmango @stinodego