HF-161: document OFFSET function limitations#1666
Open
marcin-kordas-hoc wants to merge 3 commits intodevelopfrom
Open
HF-161: document OFFSET function limitations#1666marcin-kordas-hoc wants to merge 3 commits intodevelopfrom
marcin-kordas-hoc wants to merge 3 commits intodevelopfrom
Conversation
|
Task linked: HF-161 Document limitations of the OFFSET function |
✅ Deploy Preview for hyperformula-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
3 tasks
Performance comparison of head (8b0b936) vs base (8b525cb) |
dac40ae to
563642b
Compare
Per Q2 principle (describe runtime-observable behavior, not internal strings): replace verbatim copies of internal parser error messages with behavioral descriptions. Future internal-string refactors will no longer silently invalidate these doc comments.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1666 +/- ##
========================================
Coverage 97.18% 97.18%
========================================
Files 174 174
Lines 15086 15086
Branches 3223 3223
========================================
Hits 14662 14662
Misses 424 424 🚀 New features to boost your workflow:
|
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-limitspagesLimits documented
#REF!getCellFormulareturns the resolved reference, not the original=OFFSET(...)getRegisteredFunctionNamesand the resolved reference is whatgetCellFormulareturnsRuntime verification
All six limits were verified against this branch's HEAD before publishing:
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 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 four 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 changes; no runtime behavior, APIs, or data handling are modified.
Overview
Adds a canonical
### OFFSET functionsubsection todocs/guide/known-limitations.md, explaining thatOFFSETis resolved at parse time and documenting the resulting constraints (single-cell first arg, static integer shift/size args, positive height/width,#REF!when out of bounds, andgetCellFormulareturning the rewritten reference), with small code examples.Removes the now-superseded single-row
OFFSETentry fromdocs/guide/list-of-differences.mdso the limitation is documented in one place.Reviewed by Cursor Bugbot for commit 8b0b936. Bugbot is set up for automated code reviews on this repo. Configure here.