Skip to content

docs: clarify cload pairs compression support - #483

Draft
sapunyangkut wants to merge 1 commit into
open2c:masterfrom
sapunyangkut:codex/issue-410-compression-docs
Draft

docs: clarify cload pairs compression support#483
sapunyangkut wants to merge 1 commit into
open2c:masterfrom
sapunyangkut:codex/issue-410-compression-docs

Conversation

@sapunyangkut

Copy link
Copy Markdown

Summary

  • clarify that compression for path inputs is inferred from the filename extension
  • limit the documented formats to those supported by pandas.read_csv and explicitly note that LZ4 is unsupported
  • keep the generated CLI reference synchronized with the command docstring

Closes #410

Validation

  • git diff --check
  • parsed cload.py with Python's AST
  • verified the cload pairs description is identical in the source docstring and docs/cli.rst

I could not run the full documentation build because the available package environment could not resolve a complete compatible cooler dependency set. This is a documentation-only change and does not alter runtime behavior.

This contribution was prepared with AI-assisted tooling. I reviewed the final diff and verified it against the implementation path and the maintainer's clarification in #410.

Signed-off-by: sapunyangkut <302607731+sapunyangkut@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

cooler cload does not accept .lz4-compressed .pairs files

1 participant