docs(api): fix getAllSheetsSerialized/getRangeSerialized JSDoc for number cells (HF-219)#1693
Merged
Merged
Conversation
…r number cells (HF-219) The JSDoc examples implied numeric strings are serialized as numbers (e.g. input ['1', '2', '=A1+10'] producing [1, 2, '=A1+10']). In fact serialization preserves the exact type each cell was set with: a string '1' stays the string '1', and a number 1 stays the number 1. Fix the getAllSheetsSerialized and getRangeSerialized examples and add a note describing the type-preserving behavior. Docs-only; no CHANGELOG entry per team rule. Mirrors GitHub issue #1654. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
✅ Deploy Preview for hyperformula-dev-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Performance comparison of head (691b8b1) vs base (d4195b5) |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1693 +/- ##
========================================
Coverage 97.16% 97.16%
========================================
Files 176 176
Lines 15322 15322
Branches 3356 3387 +31
========================================
Hits 14887 14887
- Misses 427 435 +8
+ Partials 8 0 -8
🚀 New features to boost your workflow:
|
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
2 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.
Fixes the
getAllSheetsSerialized/getRangeSerializedJSDoc examples that wrongly implied numeric strings are serialized as numbers — serialization round-trips, preserving the exact input type. Mirrors #1654. Documentation-only (a single source file changed), so no CHANGELOG entry per the docs-only convention.Note
Low Risk
Comment and example changes only; no runtime or serialization logic modified.
Overview
Documentation-only updates to JSDoc for
getAllSheetsSerializedandgetRangeSerializedinHyperFormula.ts.The docs now state that non-formula cells keep the exact
RawCellContenttype they were set with (string'1'vs number1), and the embedded examples were corrected so numeric literals are numbers in sample input/output instead of implying string digits are coerced to numbers on serialize.Reviewed by Cursor Bugbot for commit 691b8b1. Bugbot is set up for automated code reviews on this repo. Configure here.