HF-161: document OFFSET function limitations#1662
Closed
marcin-kordas-hoc wants to merge 2 commits into
Closed
Conversation
Contributor
|
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. |
sequba
added a commit
that referenced
this pull request
May 19, 2026
## Summary Adds a single canonical `### OFFSET function` sub-section under `## Nuances of the implemented functions` in `docs/guide/known-limitations.md`. Documents all six behavioral limits of the OFFSET function in HyperFormula, each backed either by an existing test in `unit/parser/offset-translation.spec.ts` or 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"*). The HF-vs-Excel/Sheets behavioral differences for OFFSET are not lost — they remain documented in full in `known-limitations.md` under the new sub-section, which is the canonical place for parse-time restrictions per the 04-21 decision to consolidate. > **Note on PR routing**: this PR replaces #1662 which was opened from a fork branch. Same content, now from upstream branch — CI will have full access (no fork-PR DEPLOY_TOKEN issue). Closing #1662 in favor of this one. ## Linked - Closes [#1572](#1572) — *Docs: describe limitations of the OFFSET function* - Tracks the dynamic-args follow-up: [#910](#910) - Out of scope (separate task): [#943](#943) — restructuring `known-limitations` / `list-of-differences` / `specifications-and-limits` pages - Unblocked by: [handsontable/hyperformula-tests#12](handsontable/hyperformula-tests#12) (merged 2026-05-14, cleared lint regression introduced by #1672) - Internal spec / tech rationale / implementation plan: tracked in the team workspace (not committed); summary in this PR description - Supersedes: #1662 ## Limits documented 1. First argument must be a single-cell reference (passing a range = parser error stored as cell value) 2. Row/column/height/width arguments must be static integer literals (parser error otherwise) 3. Height and width must be **bare** positive integer literals — `NUMBER` AST nodes only (unary `+`, parens, non-integers, values <1 all rejected at parse time) 4. Out-of-sheet target → `#REF!` error stored at parse time (not evaluation time), with the message *Resulting reference is out of the sheet* 5. `getCellFormula` returns the resolved reference, not the original `=OFFSET(...)` 6. Architectural rationale: OFFSET is rewritten at parse time into a plain cell reference, so introspection via `getCellFormula` shows the resolved reference rather than the call ## Runtime verification All six limits were verified against this branch's HEAD before publishing: ``` A. OFFSET in registered names: false (correct — OFFSET is parse-time, not registered) B. getCellFormula recovers: "=B1" (rewritten reference, NOT "=OFFSET(A1, 0, 1)") C. Out-of-sheet value: { value: "#REF!", message: "Resulting reference is out of the sheet." } ``` Tests covering all six limits live in `test/hyperformula-tests/unit/parser/offset-translation.spec.ts` (24 tests, lines 13–206 in the private repo). Run via `npm run test:jest -- --testPathPattern="offset-translation"`. ## Test plan - [ ] CI green on `handsontable/hyperformula` - [ ] Netlify deploy preview: [`/guide/known-limitations`](https://deploy-preview-1666--hyperformula-dev-docs.netlify.app/docs/guide/known-limitations.html) — verify the new `### OFFSET function` sub-section renders, including the four embedded `js` code blocks - [ ] Netlify deploy preview: [`/guide/list-of-differences`](https://deploy-preview-1666--hyperformula-dev-docs.netlify.app/docs/guide/list-of-differences.html) — verify the table is intact and the OFFSET row is gone ## Notes - This is docs-only — no CHANGELOG entry per project convention. - The internal `ErrorMessage.OutOfSheet` string is intentionally NOT quoted verbatim in the docs; the bullet describes the behavior instead, so future internal-string refactors don't break the docs. - Post-Codex review (2026-05-14): wording clarified to distinguish parser-error-as-cell-value vs API exception, and to specify that height/width accept only bare `NUMBER` literals (unary `+` etc. rejected). <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk docs-only change; the main risk is confusing users if the newly documented OFFSET constraints are inaccurate or drift from implementation. > > **Overview** > Adds a canonical **`### OFFSET function`** section to `docs/guide/known-limitations.md` describing HyperFormula’s parse-time rewriting behavior and the resulting constraints (single-cell first arg, static integer shifts/sizes, strict positive literal height/width, out-of-sheet `#REF!` at parse time, and `getCellFormula` returning the resolved reference), with small JS snippets. > > Removes the now-redundant `OFFSET` row from `docs/guide/list-of-differences.md` to consolidate documentation in one place. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 67ad2cd. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> --------- Co-authored-by: Kuba Sekowski <jakub.sekowski@handsontable.com>
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.