Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Explain getSheetDimensions() issue with empty rows and columns #1476

Merged
merged 1 commit into from
Dec 21, 2024

Conversation

sequba
Copy link
Contributor

@sequba sequba commented Dec 20, 2024

Context

Improve API reference of:

  • getSheetDimensions,
  • setColumnOrder
  • setRowOrder

Inspired by the discussion in issue #1471

How did you test your changes?

local docs build

Types of changes

  • Breaking change (a fix or a feature because of which an existing functionality doesn't work as expected anymore)
  • New feature or improvement (a non-breaking change that adds functionality)
  • Bug fix (a non-breaking change that fixes an issue)
  • Additional language file, or a change to an existing language file (translations)
  • Change to the documentation

Checklist:

  • I have reviewed the guidelines about Contributing to HyperFormula and I confirm that my code follows the code style of this project.
  • I have signed the Contributor License Agreement.
  • My change is compliant with the OpenDocument standard.
  • My change is compatible with Microsoft Excel.
  • My change is compatible with Google Sheets.
  • I described my changes in the CHANGELOG.md file.
  • My changes require a documentation update.
  • My changes require a migration guide.

@sequba sequba self-assigned this Dec 20, 2024
@sequba sequba marked this pull request as ready for review December 20, 2024 18:14
@sequba sequba requested a review from budnix December 20, 2024 18:16
@sequba sequba added Docs Improvements or additions to documentation Impact: Low labels Dec 20, 2024
Copy link

github-actions bot commented Dec 20, 2024

Performance comparison of head (4a1ced5) vs base (245799c)

                                     testName |   base |   head | change
------------------------------------------------------------------------
                                      Sheet A | 522.17 | 524.91 | +0.52%
                                      Sheet B | 175.17 | 173.58 | -0.91%
                                      Sheet T | 151.91 | 152.13 | +0.14%
                                Column ranges | 523.34 | 530.88 | +1.44%
Sheet A:  change value, add/remove row/column |  16.42 |  15.39 | -6.27%
 Sheet B: change value, add/remove row/column | 149.99 | 139.68 | -6.87%
                   Column ranges - add column | 167.87 | 162.81 | -3.01%
                Column ranges - without batch | 488.55 | 473.17 | -3.15%
                        Column ranges - batch | 121.76 | 121.78 | +0.02%

@sequba sequba merged commit aec974e into develop Dec 21, 2024
24 checks passed
@sequba sequba deleted the feature/docs-explain-sheet-dimensions branch December 21, 2024 17:26
Copy link

codecov bot commented Dec 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.20%. Comparing base (245799c) to head (4a1ced5).
Report is 1 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1476   +/-   ##
========================================
  Coverage    97.20%   97.20%           
========================================
  Files          169      169           
  Lines        14430    14430           
  Branches      3027     3027           
========================================
  Hits         14027    14027           
  Misses         403      403           
Files with missing lines Coverage Δ
src/HyperFormula.ts 99.73% <ø> (ø)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Improvements or additions to documentation Impact: Low
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants