Skip to content

Document the HF-349 static metadata API removal in the 3.4.0 changelog - #1742

Closed
marcin-kordas-hoc wants to merge 1 commit into
developfrom
hf-349-changelog-removed-entry
Closed

Document the HF-349 static metadata API removal in the 3.4.0 changelog#1742
marcin-kordas-hoc wants to merge 1 commit into
developfrom
hf-349-changelog-removed-entry

Conversation

@marcin-kordas-hoc

@marcin-kordas-hoc marcin-kordas-hoc commented Aug 20, 2026

Copy link
Copy Markdown
Collaborator

The 3.4.0 release removed the static HyperFormula.getAvailableFunctions() / HyperFormula.getFunctionDetails() methods (HF-349, #1724) — a breaking public-API change — but the changelog never mentioned it: the [3.4.0] section has no Removed entry, and [Unreleased] doesn't either. This adds the entry under the release that actually carried it.

Two things this deliberately does NOT do, for the reviewer to weigh:

  • it does not touch the migration guide — a breaking removal normally gets a section there (DEV_DOCS DoD); that needs an author's call on wording and placement, so it is flagged rather than guessed;
  • it does not re-announce the removal in [Unreleased] — the change shipped in 3.4.0, so documenting it there would misstate when it happened.

Docs-only change; no tests, per DoD.

🤖 Generated with Claude Code

https://claude.ai/code/session_019pxNP45obT2LZfjitaCv9o


Note

Cursor Bugbot is generating a summary for commit 3443ff2. Configure here.

The 3.4.0 release removed the static getAvailableFunctions /
getFunctionDetails methods (HF-349) but its changelog section never said
so - a breaking public-API change shipped unannounced. Documented after
the fact, under the release that actually carried it.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019pxNP45obT2LZfjitaCv9o
@qunabu

qunabu commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

@cloudflare-workers-and-pages

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 3443ff2 Commit Preview URL

Branch Preview URL
Aug 20 2026, 08:48 AM

@codecov

codecov Bot commented Aug 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.31%. Comparing base (61ead73) to head (3443ff2).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1742   +/-   ##
========================================
  Coverage    97.31%   97.31%           
========================================
  Files          195      195           
  Lines        15719    15719           
  Branches      3455     3384   -71     
========================================
  Hits         15297    15297           
- Misses         414      422    +8     
+ Partials         8        0    -8     

see 5 files with indirect coverage changes

🚀 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.

@github-actions

github-actions Bot commented Aug 20, 2026

Copy link
Copy Markdown

Performance comparison of head (3443ff2) vs base (61ead73)

                                     testName |    base |    head | change
--------------------------------------------------------------------------
                                      Sheet A |  498.99 |  504.27 | +1.06%
                                      Sheet B |  165.21 |  159.11 | -3.69%
                                      Sheet T |  143.31 |  143.72 | +0.29%
                                Column ranges |  479.77 |  477.45 | -0.48%
                                Sorted lookup | 14293.4 | 14108.3 | -1.30%
Sheet A:  change value, add/remove row/column |    16.8 |    16.1 | -4.17%
 Sheet B: change value, add/remove row/column |  134.38 |  138.19 | +2.84%
                   Column ranges - add column |  156.05 |  156.12 | +0.04%
                Column ranges - without batch |  475.04 |   488.1 | +2.75%
                        Column ranges - batch |  116.66 |  122.74 | +5.21%

@marcin-kordas-hoc

Copy link
Copy Markdown
Collaborator Author

Closing this: the premise is wrong, and the spec-to-ship review of #1743 is what exposed it.

I opened this believing HF-349 (#1724) removed a released public API without announcing it. Verified since, and it did not — the static getAvailableFunctions / getFunctionDetails were added and removed inside the 3.4.0 development cycle, so no released version ever had them:

$ git show 3.3.0:src/HyperFormula.ts | grep -c "public static getAvailableFunctions"   # 0
$ git show 3.4.0:src/HyperFormula.ts | grep -c "public static getAvailableFunctions"   # 0
$ git log --all -S "public static getAvailableFunctions" -- src/HyperFormula.ts
f2420c37f Remove the static function metadata API (HF-349) (#1724)
ebaa2b28a Function metadata API: getAvailableFunctions / getFunctionDetails (HF-249) (#1692)

HF-349's own commit message says so outright: "Both methods are unreleased, which is the only free moment to remove them." So the changelog was correct as it stood — a net-zero change inside one release cycle needs no entry — and this PR would have told every reader that we took away an API they never had.

The real instance of the problem I thought I was documenting is in #1743, which touches HyperFormula.getRegisteredFunctionNames(code) — a static that is in the released 3.4.0 tag. That one is now handled there by deprecating it instead of removing it (Semantic Versioning, plus the migration-guide requirement in DEV_DOCS's Definition of Done), with a Deprecated changelog entry in that PR.

🤖 Generated with Claude Code

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