HF-131 (7/7): documentation - #1767
Conversation
ErrorType has ten members; this guide's error table only listed nine. Add the missing #SPILL! row, matching the existing table's style, plus a short note that HyperFormula does not turn a message into a longer plain-language explanation itself — an application layer wanting that should build it on top of the type/message the engine already provides. Docs-only, no CHANGELOG entry per this repo's DoD. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
Task linked: HF-131 Verbose and actionable formula error messages |
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 9dbfe89. Configure here.
| - "#CYCLE!" | ||
| - "#ERROR!" | ||
| - "#LIC!" | ||
| - "#SPILL!" |
There was a problem hiding this comment.
Tag list exceeds the ten-tag limit
Low Severity
Adding #SPILL! brings the tags list to 11 entries. VuePress search indexes only title, tags, and headings, and the project cap is 10 tags per page so extra tags can crowd out more relevant hits once the 10-result limit applies.
Triggered by learned rule: VuePress tags frontmatter invariants
Reviewed by Cursor Bugbot for commit 9dbfe89. Configure here.
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
hyperformula-docs | 5d90bec | Commit Preview URL Branch Preview URL |
Sep 11 2026, 05:38 AM |
Performance comparison of head (5d90bec) vs base (d56bd3d) |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## fix/hf-131-issue-444-addresses #1767 +/- ##
===============================================================
Coverage 97.40% 97.40%
===============================================================
Files 195 195
Lines 15834 15834
Branches 3491 3491
===============================================================
Hits 15423 15423
Misses 403 403
Partials 8 8 🚀 New features to boost your workflow:
|


What and why
Stacked on #1766, the last in this stack. Documentation only.
#SPILL!row todocs/guide/types-of-errors.md(the type existed and wasproducible before this stack, just undocumented) and a new "Error messages and explanations"
section explaining what
messagedoes and doesn't do: it states the specific cause within anerror's type, but HyperFormula does not turn it into a longer plain-language explanation or call
out to an LLM to generate one — an application wanting to rephrase for end users should do so at
the application layer, using
type/messageas input.docs/guide/custom-functions.mdexplaininghasMessage(HF-131 (3/7): a consumer can tell 'no message' from 'empty message' #1763) for authorsof custom functions.
No
src/changes in this PR.Verified
npm run docs:build— clean, both new docs pieces present in rendered outputpre-existing branch-pinning mismatch as the rest of this stack (unaffected by a docs-only change,
included for completeness since it's the tip of the stack)
Stack
7 of 7 — stacked on #1766. Last PR in the HF-131 stack: #1761 → #1762 → #1763 → #1764 → #1765 →
#1766 → this one.
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only; no runtime or API behavior changes.
Overview
Documentation-only update to
docs/guide/types-of-errors.md.Adds
#SPILL!to the guide tags and error table (no space for an array result to spill when non-empty cells would be overwritten). Introduces Error messages and explanations, clarifying that each error’smessagepinpoints the cause within its type, that HyperFormula does not expand messages into longer prose or use an LLM for that, and that apps should rephrase or translate errors for end users usingtypeandmessage.Reviewed by Cursor Bugbot for commit 5d90bec. Bugbot is set up for automated code reviews on this repo. Configure here.