Repository navigation
docs: clarify row iterator column offsets - #237
ryanduguid wants to merge 3 commits into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Walkthrough
Merge Risk: ⚪ Minimal · up to
|
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Out of Scope Changes check |  |
The workflow changes replace ubuntu-latest with ubuntu-24.04 and change runner fallback selection. These changes do not implement or support the documentation requirement in issue #177. |
Remove the unrelated .github/workflows/CI.yml changes from this pull request, or link them to a separate issue and submit them separately. |
-
Check name Status Explanation Linked Issues check Issue #177permits documentation clarification.README.mdandCalamineSheet.iter_rowsdocumentation explain the leading row and column offsets, theC3/D3example, and the difference from `to_p…Docstring Coverage Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 1 files. (1 skipped: 1 … Description Check Check skipped - CodeRabbit’s high-level summary is enabled. Title check The title clearly and concisely describes the main change: documentation that clarifies column offsets for the row iterator. Full details: Linked Issues check
-
Explanation
Issue
#177permits documentation clarification.README.mdandCalamineSheet.iter_rowsdocumentation explain the leading row and column offsets, theC3/D3example, and the difference fromto_python(skip_empty_area=False). The reported checks support the documented behavior.
Full details: Docstring Coverage
-
Explanation
Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 1 files. (1 skipped: 1 unsupported.)
-
- Fix all pre-merge checks with AI
✨ Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Create a new PR
-
- Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
A rabbit reads the rows with care
And notes which columns start elsewhere
The README tells the offsets right
Ubuntu runners join the flight
The carrots wait; the checks are green
A tidy patch for sheets unseen
Comment @coderabbitai help to get the list of available commands.
This branch has not been deployed
2 participants
Summary
Clarify the different offset handling of
iter_rows()andto_python()in the README and iterator docstring. For cells C3/D3, the iterator yields two blank rows of width two before the data, whileto_python(skip_empty_area=False)retains the leading columns as well.Explain how the second item of
sheet.startidentifies the column offset for a non-empty sheet. Closes #177.Evidence
pytest tests/test_base.py -qpassed all 34 cases with the released wheel; mypy and stubtest also passed.pip install -e ., thenpytestreported 51 passed and one existing expected failure for the OdfReader timedelta case.pre-commit run --all-filespassed every hook, including Rust formatting, Clippy, mypy and stubtest. Whitespace checks pass, and the checked Linux patch matches this PR exactly.Risk
This is a reversible documentation change affecting the README and iterator docstring. The offset explanation is checked against the current Rust source and the released wheel.
Unverified
Rust unit tests, the full Windows suite, and the remaining Python/OS and PyEmscripten combinations were not run. Upstream CI awaits maintainer approval.
CI workflow maintenance
Use Ubuntu 24.04 for the affected Linux jobs. Keep the existing event, permission and test-matrix contracts.
Pin the computed Linux runner fallback while preserving explicit, Windows and macOS selections.
Evidence
The previous head reported 24 matching action-runtime or runner annotations. Actionlint reports no new diagnostics against the previous workflow files; existing diagnostics remain. The Git whitespace check passes.
Risk
Action or runner upgrades can affect CI behaviour. The workflow changes can be reverted.
Unverified
Hosted CI observed at 2026-10-17T11:24:12Z for 998777d: 2 skipped, 32 success. No action-runtime or Ubuntu-label annotations were reported. Application tests were not run locally for these workflow changes.
Summary by CodeRabbit
iter_rows()handles leading empty rows and columns, including how to locate the first included column.to_python()skips empty areas by default, and thatskip_empty_area=Falsepreserves the row and column offsets.