Skip to content

[#8]:svarga:docs, add usage examples#35

Merged
steven-varga merged 1 commit into
stagingfrom
8-docs-add-usage-examples
May 14, 2026
Merged

[#8]:svarga:docs, add usage examples#35
steven-varga merged 1 commit into
stagingfrom
8-docs-add-usage-examples

Conversation

@steven-varga
Copy link
Copy Markdown
Contributor

Summary

  • docs/types.md — new type-selection guide: decision matrix + one working example per representation (BID, fixed, BCD, scaled)
  • docs/scaled.md — replaced stale dev-era spec (described wrong API with kind field and make_zero()/make_inf() helpers that don't exist) with accurate math::scaled::decimal_t documentation

Test plan

  • mkdocs serve renders both pages without errors
  • All code snippets in docs/types.md compile against current staging headers
  • docs/scaled.md API matches include/decimal/scaled.hpp (no phantom fields or helpers)

@codecov
Copy link
Copy Markdown

codecov Bot commented May 13, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@steven-varga steven-varga merged commit a771bc4 into staging May 14, 2026
17 checks passed
@steven-varga steven-varga deleted the 8-docs-add-usage-examples branch May 14, 2026 00:02
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