Skip to content

fix(docs): correct API contracts and stabilize browser checks - #27

Merged
koenvanexem merged 1 commit into
mainfrom
fix/documentation-review
Oct 19, 2026
Merged

koenvanexem merged 1 commit into
mainfrom
fix/documentation-review

Conversation

@koenvanexem

Copy link
Copy Markdown
Member

Summary

Follow up on all five review findings from #25. The documentation overstated callback, range-parsing, cell-coordinate and value-conversion guarantees, and the navigation checks could measure page width before Mermaid finished rendering.

  • Distinguish the interop callbacks that await program Tasks from callers that discard them, including the implications of async event handlers.
  • Document headless range-parser exceptions and the explicit-endpoint workaround, stale cell coordinates after row or column changes, and decimal conversion bounds and exceptions.
  • Keep the API reference, virtual-workbook explanation, terminology and known-defect list consistent. These corrections describe existing runtime behaviour; they do not change the library implementation.
  • Wait for the Mermaid diagram before both keyboard-navigation overflow assertions.

Validation

Completed on 2026-10-19:

  • npm test: 21 tests passed.
  • npm run check: no errors, warnings or hints.
  • npm run build, npm run check:links and npm run test:browser passed at both / and /excel/: 718 links checked and 14 browser tests passed per deployment path.
  • Repeated keyboard-navigation checks: 20 tests passed.
  • Reviewed generated Markdown exports, the narrow API layout, factual accuracy, terminology and Oxford English; git diff --check passed.
  • task compile passed. Headless tests: 46 passed. Chunk tests: 11 passed on each of net462 and net10.0, plus 11 passed through the net462 console runner.

Real Excel tests were not rerun because the existing Microsoft 365 privacy dialog blocks unattended execution.

Follow up on the review of #25. Distinguish awaited and discarded callback Tasks, document headless range-parser and cell-coordinate limitations, and describe decimal conversion bounds and exceptions without promising type preservation. These changes document existing runtime behaviour rather than altering the library.

Wait for Mermaid rendering before both keyboard-navigation overflow assertions so the checks do not measure the unrendered diagram source.

Validated on 2026-10-19: 21 tooling tests; Astro check with no diagnostics; builds, 718 links and 14 browser tests at both / and /excel/; 20 repeated keyboard-navigation checks; task compile; 46 headless tests; chunk tests on net462 and net10.0 plus the net462 console runner. Real Excel tests were not rerun because the existing Microsoft 365 privacy dialog blocks unattended execution.
@koenvanexem
koenvanexem merged commit 042f2a4 into main Oct 19, 2026
3 checks passed
@koenvanexem
koenvanexem deleted the fix/documentation-review branch October 19, 2026 13:05
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