Skip to content

docs(patch): fix stale NaN semantics documentation after signalling change#5

Merged
hassila merged 1 commit intomainfrom
hassila-fix-nan-docs
Mar 30, 2026
Merged

docs(patch): fix stale NaN semantics documentation after signalling change#5
hassila merged 1 commit intomainfrom
hassila-fix-nan-docs

Conversation

@hassila
Copy link
Copy Markdown
Contributor

@hassila hassila commented Mar 30, 2026

Summary

  • Fix documentation that still described quiet NaN (propagation) behavior after the signalling NaN change in feat(major): Make NaN signalling (trap on use) #2
  • Updates README, TypeDesign.md, GettingStarted.md, and pow() doc comment to correctly describe trapping semantics

Changes

File Fix
README.md NaN example now shows trapping; fuzz description says "NaN trapping"
TypeDesign.md NaN semantics bullet: "propagates" → "traps (signalling)"
GettingStarted.md Rewrote NaN section for trapping behavior
FixedPointDecimal.swift pow() doc: "Returns .nan" → precondition documentation

Test plan

  • Verified all 7 DocC files against implementation — no remaining discrepancies
  • swift build compiles cleanly (docs-only change)

🤖 Generated with Claude Code

The NaN implementation was changed to signalling in 786e963 but several
documentation files still described the old quiet (propagating) behavior.

- README: fix NaN example and fuzz testing description
- TypeDesign.md: correct NaN semantics bullet from "propagates" to "traps"
- GettingStarted.md: rewrite NaN section for trapping semantics
- FixedPointDecimal.swift: fix pow() doc comment precondition

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@hassila hassila changed the title docs: fix stale NaN semantics after signalling change docs(patch): fix stale NaN semantics after signalling change Mar 30, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 30, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.62%. Comparing base (2277c89) to head (757dba3).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main       #5   +/-   ##
=======================================
  Coverage   98.62%   98.62%           
=======================================
  Files          28       28           
  Lines        3840     3840           
=======================================
  Hits         3787     3787           
  Misses         53       53           
Files with missing lines Coverage Δ
Sources/FixedPointDecimal/FixedPointDecimal.swift 87.60% <ø> (ø)
Files with missing lines Coverage Δ
Sources/FixedPointDecimal/FixedPointDecimal.swift 87.60% <ø> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2277c89...757dba3. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@hassila hassila requested review from freef4ll and jhansbo March 30, 2026 09:05
@hassila hassila changed the title docs(patch): fix stale NaN semantics after signalling change docs(patch): fix stale NaN semantics documentation after signalling change Mar 30, 2026
@github-actions
Copy link
Copy Markdown

@hassila hassila merged commit 286b753 into main Mar 30, 2026
13 of 14 checks passed
@hassila hassila deleted the hassila-fix-nan-docs branch March 30, 2026 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants