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.

Sign up for GitHub

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

Jump to bottom

Make typedoc generate documentation for cellerror and other minor classes #1491

Merged
merged 1 commit into from
Feb 4, 2025
Merged

Make typedoc generate documentation for cellerror and other minor classes #1491

merged 1 commit into from
Feb 4, 2025

Conversation

sequba
Copy link
Contributor

@sequba sequba commented Jan 28, 2025 •
edited
Loading

Context

The typedoc documentation has been changed to get rid of the broken links found by the google crawler.

  • Before: typedoc generates documentation only for 3 specified source files (and the classes and interfaces closely related to them)
  • After: typedoc generates documentation for the entire codebase except for the files that are explicitly excluded

How did you test your changes?

  • local docs build

❗ TODO: before releasing, test the documentation in the staging env

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

Related issues:

Fixes #1483

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 linked an issue Jan 28, 2025 that may be closed by this pull request
[Bug]: There are 404 errors in our docs reported by the Google Search Console #1483
Open
@sequba sequba marked this pull request as ready for review January 28, 2025 14:48
@sequba sequba requested a review from budnix January 28, 2025 14:50
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 28, 2025 •
edited
Loading

Performance comparison of head (411ad61) vs base (ed575db)

                                     testName |   base |   head |  change
-------------------------------------------------------------------------
                                      Sheet A | 520.62 | 503.94 |  -3.20%
                                      Sheet B | 172.03 | 168.84 |  -1.85%
                                      Sheet T | 145.51 |  144.3 |  -0.83%
                                Column ranges | 507.51 |  520.6 |  +2.58%
Sheet A:  change value, add/remove row/column |  15.25 |  13.42 | -12.00%
 Sheet B: change value, add/remove row/column | 122.87 | 128.53 |  +4.61%
                   Column ranges - add column | 154.26 | 150.54 |  -2.41%
                Column ranges - without batch | 444.56 | 437.43 |  -1.60%
                        Column ranges - batch | 113.06 | 110.14 |  -2.58%

@sequba sequba merged commit 14ae706 into develop Feb 4, 2025
24 checks passed
@sequba sequba deleted the feature/issue-1483 branch February 4, 2025 06:41
@codecov Codecov
Copy link

codecov bot commented Feb 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.22%. Comparing base (ed575db) to head (411ad61).
Report is 1 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1491   +/-   ##
========================================
  Coverage    97.22%   97.22%           
========================================
  Files          169      169           
  Lines        14523    14523           
  Branches      3080     3169   +89     
========================================
  Hits         14120    14120           
+ Misses         403      396    -7     
- Partials         0        7    +7

see 4 files with indirect coverage changes

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

@budnix budnix budnix approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Bug]: There are 404 errors in our docs reported by the Google Search Console
2 participants
@sequba @budnix