docs(guide): named ranges in formulas + fix limitations pointer (HF-222) - #1695
Merged
Merged
Conversation
✅ Deploy Preview for hyperformula-dev-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…ter (HF-222) Adds a 'Using named ranges in formulas' section to named-expressions.md (behavior as function arg / operator operand / bare ref, incl. array mode) and replaces the inaccurate top-level named-ranges bullet in known-limitations.md with a neutral pointer. Docs-only. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
marcin-kordas-hoc
force-pushed
the
hf-222-named-ranges
branch
from
June 22, 2026 07:25
28781e8 to
8a53e27
Compare
Performance comparison of head (2844367) vs base (72205bd) |
sequba
requested changes
Jun 24, 2026
Contributor
|
Task linked: HF-222 Describe the limitations of named expressions |
…ew (HF-222) The previous wording stated unconditionally that SUM(myRange+1) receives a single reduced value. The unit tests (PR #15) and the engine confirm it is element-wise in array mode (SUM(2,3,4,5,6)=20). Scope the reduction claim to default mode and document the array-mode element-wise behavior. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1695 +/- ##
========================================
Coverage 97.16% 97.16%
========================================
Files 176 176
Lines 15322 15322
Branches 3387 3387
========================================
Hits 14887 14887
Misses 435 435 🚀 New features to boost your workflow:
|
sequba
approved these changes
Jun 25, 2026
GreenFlux
added a commit
that referenced
this pull request
Jul 1, 2026
Brings in two content commits that landed on develop: - 72205bd docs(api): fix getAllSheetsSerialized/getRangeSerialized JSDoc for number cells (HF-219) (#1693) — library JSDoc edit; API ref regens from source, no docs-side conflict. - 8bfa558 docs(guide): named ranges in formulas + fix limitations pointer (HF-222) (#1695) — added ~40 lines to two guide pages that we migrated. Auto-merge couldn't reconcile these because git's rename detection was defeated by the size of the change (named-expressions) and by our base-prefixed link rewrites (known-limitations). Manual resolutions: - `docs/guide/named-expressions.md`: confirmed the delete (legacy path). - `docs/src/content/docs/guide/named-expressions.md`: appended develop's new "Using named ranges in formulas" section before "## Available methods", verbatim except for using the same link form our tree uses. - `docs/src/content/docs/guide/known-limitations.md`: took develop's replacement bullet in place of the older "no data validation against named ranges" line, then rewrote its links from legacy `named-expressions.md#...` / `custom-functions.md#...` to our base-prefixed `/docs/guide/named-expressions#...` / `/docs/guide/custom-functions#...` form. Local `npm run build` produces 214 pages, no errors.
9 tasks
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
3 participants
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.
Documents how a range-valued named expression behaves in a formula and fixes the inaccurate limitations bullet (HF-222).
named-expressions.md: new Using named ranges in formulas section — behavior as function argument (full range), operator operand (implicit intersection → single cell; array mode →#VALUE!), and bare reference (#VALUE!).known-limitations.md: replaces the inaccurate top-level named-ranges bullet with a neutral pointer to that section.Paired characterization tests: hyperformula-tests branch
hf-222-named-ranges(matching branch for fetch-tests). Docs-only; no CHANGELOG.Note
Low Risk
Documentation-only changes with no runtime or API impact.
Overview
Documents how range-valued named expressions behave in formulas and corrects a misleading limitations note.
named-expressions.mdadds Using named ranges in formulas: full range when passed to functions; implicit intersection to one cell (or#VALUE!) when used with operators;#VALUE!for a bare range reference. It also contrasts default evaluation withuseArrayArithmetic: true(e.g.=SUM(myRange + 1)vs element-wise sum).known-limitations.mddrops the inaccurate claim that named ranges can’t be used in comparisons like=IF(firstRange>secondRange, …)and points readers to the new section instead.Reviewed by Cursor Bugbot for commit 2844367. Bugbot is set up for automated code reviews on this repo. Configure here.