tubedude / finance-elixir / 696ebfa1d64e0436d9b1857e10b69a2d43f123ca-PR-29

100%

master: 100%

Pull #29

github

Release-readiness pass from the whole-library review

Options:
- Every function validates only the options it uses (four compiled schemas:
  dated rate, rate, dated value, value), so an inapplicable option — :basis on
  periodic irr, :guess on xnpv or a Bonds metric — raises instead of being
  silently ignored. npv validates options before rejecting empty data.
- :precision is 0..15 in the Returns and amortization schemas too, completing
  the change 1.6.1 claimed; Finance.option gains the missing {:basis, _}.

Behavior:
- xnfv returns {:error, :undefined} when forward compounding overflows, instead
  of being the one value function that raises.
- The Returns cash-flow metrics coerce amounts via Shared.to_amount, so Decimal
  and Money inputs work there like they do in CashFlow.

Tests: a property pinning Decimal/Money value-transparency on the coercion
seam; cross-basis contracts (irr==xirr, xnfv/xnpv ratio, batch with basis +
Brent together); the 30/360 Feb-29 no-EOM pin; fractional bond years.

Docs: restore the lost 1.6.1 CHANGELOG heading (its content had absorbed into
1.7.0); README pins ~> 1.7, module map gains DayCount and xnfv/conventional?,
error table gains :undefined; ExDoc gets source_ref and module groups; the
first xirr doctest teaches a 20% rate instead of a 2111% regression anchor.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AVibXT2w1dEdVtMHqffFKn

65 of 65 new or added lines in 6 files covered. (100.0%)

495 of 495 relevant lines covered (100.0%)

64050.37 hits per line