Skip to content

DOC: Document the filters argument in read_parquet #52238

Closed
@MrPowers

Description

@MrPowers

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/docs/reference/api/pandas.read_parquet.html

Documentation problem

The filters argument is massively important when reading Parquet files, but it's currently undocumented. It is documented in the Dask documentation: https://docs.dask.org/en/stable/generated/dask.dataframe.read_parquet.html

I actually didn't even think pandas supported this argument, but apparently, it's supported & undocumented.

Suggested fix for documentation

I think the Dask documentation can carry over pretty well to the pandas documentation, but we should use language that's easier to understand. I don't think we should use the "disjunctive normal form (DNF)" terminology - that's just unnecessary.

Let me know if the community supports this fix and I'd be happy to draft some language.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions