Skip to content

HF-131 (7/7): documentation - #1767

Open
marcin-kordas-hoc wants to merge 3 commits into
fix/hf-131-issue-444-addressesfrom
docs/hf-131-types-of-errors
Open

HF-131 (7/7): documentation#1767
marcin-kordas-hoc wants to merge 3 commits into
fix/hf-131-issue-444-addressesfrom
docs/hf-131-types-of-errors

Conversation

@marcin-kordas-hoc

@marcin-kordas-hoc marcin-kordas-hoc commented Sep 10, 2026

Copy link
Copy Markdown
Collaborator

What and why

Stacked on #1766, the last in this stack. Documentation only.

  • Adds the missing #SPILL! row to docs/guide/types-of-errors.md (the type existed and was
    producible before this stack, just undocumented) and a new "Error messages and explanations"
    section explaining what message does and doesn't do: it states the specific cause within an
    error'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/message as input.
  • Adds a paragraph to docs/guide/custom-functions.md explaining hasMessage (HF-131 (3/7): a consumer can tell 'no message' from 'empty message' #1763) for authors
    of custom functions.

No src/ changes in this PR.

Verified

  • npm run docs:build — clean, both new docs pieces present in rendered output
  • Full private test suite reproduced against this branch's tip — no regressions beyond the same
    pre-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’s message pinpoints 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 using type and message.

Reviewed by Cursor Bugbot for commit 5d90bec. Bugbot is set up for automated code reviews on this repo. Configure here.

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>
@qunabu

qunabu commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ 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!"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Fix in Cursor Fix in Web

Triggered by learned rule: VuePress tags frontmatter invariants

Reviewed by Cursor Bugbot for commit 9dbfe89. Configure here.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 10, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

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

@github-actions

github-actions Bot commented Sep 10, 2026

Copy link
Copy Markdown

Performance comparison of head (5d90bec) vs base (d56bd3d)

                                     testName |    base |    head | change
--------------------------------------------------------------------------
                                      Sheet A |  505.95 |  513.34 | +1.46%
                                      Sheet B |  162.82 |  167.22 | +2.70%
                                      Sheet T |  144.72 |  148.24 | +2.43%
                                Column ranges |  483.06 |  484.23 | +0.24%
                                Sorted lookup | 15211.5 | 14722.9 | -3.21%
Sheet A:  change value, add/remove row/column |   16.46 |   16.58 | +0.73%
 Sheet B: change value, add/remove row/column |   148.1 |  148.75 | +0.44%
                   Column ranges - add column |  159.09 |  157.59 | -0.94%
                Column ranges - without batch |  491.55 |  491.17 | -0.08%
                        Column ranges - batch |  122.84 |  121.87 | -0.79%

@codecov

codecov Bot commented Sep 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.40%. Comparing base (d56bd3d) to head (5d90bec).

Additional details and impacted files

Impacted file tree graph

@@                       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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants