Docs: document the circular-reference default-behavior difference from Excel - #1770
Open
marcin-kordas-hoc wants to merge 1 commit into
Open
marcin-kordas-hoc wants to merge 1 commit into
marcin-kordas-hoc wants to merge 1 commit into
Conversation
…m Excel Adds a row to list-of-differences.md distinct from the existing 'Dependency collection' row (which is scoped to *false* cycles caught by static dependency analysis, e.g. IF(FALSE(), A1, 0)). This one covers a *genuine* circular reference under default settings: HyperFormula always returns CYCLE (iterative calculation, which would let it converge instead, is not yet part of a released version -- #1545); Excel's default (iterative calculation off) is to silently settle the cell to a computed value (0 for a simple self-reference) with no cell-level error at all. Measured live against Excel Online via MS Graph while closed-loop testing HF-131 (message/origin/address on cell errors) -- this difference predates that work and isn't something it changes; documenting it here rather than folding it into that stack, since it's unrelated in scope. Google Sheets' behavior for this specific case was not verified this session and is marked as such rather than assumed from the adjacent row. Verified: npm run docs:build succeeds, the new row renders correctly and the #1545 link resolves. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
hyperformula-docs | 838df28 | Commit Preview URL Branch Preview URL |
Sep 11 2026, 03:00 AM |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1770 +/- ##
========================================
Coverage 97.32% 97.32%
========================================
Files 195 195
Lines 15739 15739
Branches 3390 3461 +71
========================================
Hits 15318 15318
+ Misses 421 413 -8
- Partials 0 8 +8 🚀 New features to boost your workflow:
|
Performance comparison of head (838df28) vs base (c920375) |
Tobiadefami
reviewed
Sep 21, 2026
Tobiadefami
left a comment
Collaborator
There was a problem hiding this comment.
Looks good from the checks performed.
Verified that =A1+1 in A1 displays 0 in Excel Online.
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.
What and why
Documentation only. Adds a row to
docs/guide/list-of-differences.mdfor a genuine circularreference under default settings (
A1:=A1+1), distinct from the existing "Dependency collection"row, which is scoped specifically to false cycles caught by static dependency analysis
(
IF(FALSE(), A1, 0)) — a different mechanism, a different result shape.CYCLEunless iterative calculation is explicitly enabled(iterative calculation isn't yet part of a released version — #1545).
(
0for a simple self-reference), with no cell-level error at all and no way to detect thecycle from the result alone.
Measured live against Excel Online via MS Graph while closed-loop testing a different, unrelated
stack (message/origin/address on cell errors) — this difference predates that work and isn't
something it changes. Google Sheets' behavior for this specific case wasn't verified this session
and is marked "Not verified" rather than assumed from the adjacent row.
Verified
npm run docs:build— clean; the new row renders correctly and the#1545link resolves🤖 Generated with Claude Code
Note
Low Risk
Documentation-only change to the compatibility guide; no runtime or API impact.
Overview
Adds a Circular references row to the compatibility table in
list-of-differences.md, usingA1:=A1+1to document default behavior separately from the existing Dependency collection row (static/false cycles).The new row states that HyperFormula always surfaces a
CYCLEerror (with a link to #1545 for unreleased iterative calculation), marks Google Sheets as not verified for this case, and notes that Excel with iterative calculation off shows no cell error and settles to a value (e.g.0) with no cycle visible from the result alone.Reviewed by Cursor Bugbot for commit 838df28. Bugbot is set up for automated code reviews on this repo. Configure here.