Skip to content

Clarify HTML export API contracts and engine limitations - #29

Merged
jochenwezel merged 3 commits into
mainfrom
codex/issue-9-html-api-docs
Oct 8, 2026
Merged

jochenwezel merged 3 commits into
mainfrom
codex/issue-9-html-api-docs

Conversation

@jochenwezel

@jochenwezel jochenwezel commented Oct 8, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Review HTML worksheet/workbook option and export XML documentation against actual engine behavior.
  • Clarify document versus section/content output, filtering, defaults, one-based EPPlus header row numbers, ignored range options, and empty-sheet placeholder handling.
  • Remove inaccurate promises of inline image export and document the existing non-awaitable Async Sub behavior, including the worksheet async/sync markup difference.
  • Document the navigation overloads and exceptions with resolved XML references; preserve all signatures and runtime behavior.
  • Update the issue add export feature to HTML #9 strategy with the remaining API compatibility/design follow-ups.
  • Dynamically append the XLSX template filename to A2 in the loaded reference workbook before HTML export. The checked-in XLSX files are not changed. Test both the exported source label and the original file hash.

The current API checker already covers both HTML option classes and HtmlDocumentExportParts without temporary exclusions; no checker baseline or exclusions are changed.

Verification

  • Strict API documentation checker: no missing, incomplete, or undocumented override entries.
  • ExcelOps build: .NET Framework 4.8 and .NET 6, no XML documentation warnings.
  • Existing HTML tests on .NET 8: 22 passed, 11 expected skips, no failures.
  • Updated theme review tests, including dynamic A2 labels: 16 passed, 8 expected skips on both .NET 8 and .NET Framework 4.8. Regenerated 24 local review HTML files.
  • Compared all three VB files after removing XML comments: runtime source unchanged.
  • git diff --check passed.

Refs #9. Remaining engine implementations and API redesign remain open. This documentation/test-only follow-up is not part of the already published 2026.10.08.0 release. Production runtime behavior and checked-in XLSX fixtures are unchanged.

@jochenwezel jochenwezel mentioned this pull request Oct 8, 2026
2 of 5 tasks
@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Unit Test Statistics (ubuntu-latest) CompuMaster.MsExcelComInteropTest.dll

2 tests  ±0   2 ✅ ±0   0s ⏱️ ±0s
1 suites ±0   0 💤 ±0 
1 files   ±0   0 ❌ ±0 

Results for commit f377ad4. ± Comparison against base commit c1222de.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Unit Test Statistics (ubuntu-latest) CompuMaster.Excel.Test.dll

110 tests  ±0   110 ✅ ±0   5s ⏱️ ±0s
  1 suites ±0     0 💤 ±0 
  1 files   ±0     0 ❌ ±0 

Results for commit f377ad4. ± Comparison against base commit c1222de.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Unit Test Statistics (ubuntu-latest) CompuMaster.Excel.TestFreeSpireXls.dll

6 tests  ±0   6 ✅ ±0   0s ⏱️ ±0s
1 suites ±0   0 💤 ±0 
1 files   ±0   0 ❌ ±0 

Results for commit f377ad4. ± Comparison against base commit c1222de.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Unit Test Statistics (ubuntu-latest) CompuMaster.Excel.TestSpireXls.dll

6 tests  ±0   6 ✅ ±0   0s ⏱️ ±0s
1 suites ±0   0 💤 ±0 
1 files   ±0   0 ❌ ±0 

Results for commit f377ad4. ± Comparison against base commit c1222de.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Unit Test Statistics (windows-latest) CompuMaster.MsExcelComInteropTest.dll

2 tests  ±0   2 ✅ ±0   0s ⏱️ ±0s
1 suites ±0   0 💤 ±0 
1 files   ±0   0 ❌ ±0 

Results for commit f377ad4. ± Comparison against base commit c1222de.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Unit Test Statistics (windows-latest) CompuMaster.Excel.Test.dll

345 tests  ±0   345 ✅ ±0   44s ⏱️ - 3m 8s
  1 suites ±0     0 💤 ±0 
  1 files   ±0     0 ❌ ±0 

Results for commit f377ad4. ± Comparison against base commit c1222de.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Unit Test Statistics (windows-latest) CompuMaster.Excel.TestFreeSpireXls.dll

84 tests  ±0   84 ✅ ±0   19s ⏱️ -16s
 1 suites ±0    0 💤 ±0 
 1 files   ±0    0 ❌ ±0 

Results for commit f377ad4. ± Comparison against base commit c1222de.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Unit Test Statistics (windows-latest) CompuMaster.Excel.TestSpireXls.dll

86 tests  ±0   86 ✅ ±0   20s ⏱️ -1s
 1 suites ±0    0 💤 ±0 
 1 files   ±0    0 ❌ ±0 

Results for commit f377ad4. ± Comparison against base commit c1222de.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Unit Test Statistics (macos-latest) CompuMaster.MsExcelComInteropTest.dll

2 tests  ±0   2 ✅ ±0   0s ⏱️ ±0s
1 suites ±0   0 💤 ±0 
1 files   ±0   0 ❌ ±0 

Results for commit f377ad4. ± Comparison against base commit c1222de.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Unit Test Statistics (macos-latest) CompuMaster.Excel.Test.dll

110 tests  ±0   110 ✅ ±0   6s ⏱️ -1s
  1 suites ±0     0 💤 ±0 
  1 files   ±0     0 ❌ ±0 

Results for commit f377ad4. ± Comparison against base commit c1222de.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Unit Test Statistics (macos-latest) CompuMaster.Excel.TestFreeSpireXls.dll

6 tests  ±0   6 ✅ ±0   0s ⏱️ -1s
1 suites ±0   0 💤 ±0 
1 files   ±0   0 ❌ ±0 

Results for commit f377ad4. ± Comparison against base commit c1222de.

♻️ This comment has been updated with latest results.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Unit Test Statistics (macos-latest) CompuMaster.Excel.TestSpireXls.dll

6 tests  ±0   6 ✅ ±0   0s ⏱️ ±0s
1 suites ±0   0 💤 ±0 
1 files   ±0   0 ❌ ±0 

Results for commit f377ad4. ± Comparison against base commit c1222de.

♻️ This comment has been updated with latest results.

@jochenwezel
jochenwezel merged commit f97a81f into main Oct 8, 2026
15 checks passed
@jochenwezel
jochenwezel deleted the codex/issue-9-html-api-docs branch October 8, 2026 18:25
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.

1 participant