HF-161: document OFFSET function limitations#1662
Closed
marcin-kordas-hoc wants to merge 2 commits intohandsontable:developfrom
Closed
HF-161: document OFFSET function limitations#1662marcin-kordas-hoc wants to merge 2 commits intohandsontable:developfrom
marcin-kordas-hoc wants to merge 2 commits intohandsontable:developfrom
Conversation
|
Task linked: HF-161 Document limitations of the OFFSET function |
3 tasks
Collaborator
Author
|
Superseded by #1666. Same content (same HEAD SHA), but routed from the upstream branch instead of fork. The fork-side PR was hitting a structural CI failure: 3 matrix checks ( Worktree push routing for future PRs is being fixed locally so this won't repeat. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a single canonical
### OFFSET functionsub-section under## Nuances of the implemented functionsindocs/guide/known-limitations.md. Documents all six behavioral limits of the OFFSET function in HyperFormula, each backed either by an existing test inunit/parser/offset-translation.spec.tsor by a runtime check captured before this PR was opened.Removes the now-superseded one-row OFFSET entry from
docs/guide/list-of-differences.md(per Kuba's decision in the 2026-04-21 meeting: "można wtedy to stąd też usunąć. Żeby wszystko było tam jednak").Linked
known-limitations/list-of-differences/specifications-and-limitspagesagents/hyperformula/docs/specs/2026-04-21-hf-161-offset-limitations.mdagents/hyperformula/docs/specs/2026-04-24-hf-161-tech-rationale.mdagents/hyperformula/docs/specs/2026-04-28-hf-161-offset-docs-plan.mdLimits documented
#REF!getCellFormulareturns the resolved reference, not the original=OFFSET(...)FunctionRegistry._protectedPlugins, not as a regular pluginRuntime verification
All six limits verified runtime against this branch's HEAD before publishing. Excerpt:
Test references (private repo)
All six limits are covered by
test/hyperformula-tests/unit/parser/offset-translation.spec.tslines 13–206 (24 tests). Run vianpm run test:jest -- --testPathPattern="offset-translation".Test plan
handsontable/hyperformulanpm run docs:devand visit/guide/known-limitationsto verify the new sub-section renders, including the five embeddedjscode blocks/guide/list-of-differencesto confirm the table is intact and the OFFSET row is goneNotes
ErrorMessage.OutOfSheetstring is intentionally NOT quoted verbatim in the docs; the bullet describes the behavior instead, so future internal-string refactors don't break the docs.Note
Low Risk
Docs-only updates that clarify
OFFSETbehavior and relocate existing information; no runtime or API changes.Overview
Adds a canonical
### OFFSET functionsection todocs/guide/known-limitations.mddocumenting HyperFormula’s parse-timeOFFSETrewriting and the resulting constraints (single-cell first arg, static integer shifts/sizes, positive height/width, out-of-bounds#REF!, andgetCellFormulareturning the resolved reference).Removes the now-redundant
OFFSETentry from thedocs/guide/list-of-differences.mdtable.Reviewed by Cursor Bugbot for commit dac40ae. Bugbot is set up for automated code reviews on this repo. Configure here.