[Jah-yee]

Description

The annuity conversion formula in the pv_to_annuity docstring had an incorrect numerator:

Before (wrong):
\frac{A}{P}(i, N) = \frac{i + (1 + i)^N}{(1 + i)^N - 1}

After (correct):
\frac{A}{P}(i, N) = \frac{i(1 + i)^N}{(1 + i)^N - 1}

The actual implementation was already correct; only the documentation math formula was wrong.

Fixes #384

Summary by CodeRabbit

• Documentation
  • Corrected the documented annuity formula to match the existing implementation.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: Repository: TemoaProject/temoa/.coderabbit.yaml
• Review profile: ASSERTIVE
• Plan: Advanced
• Run ID: 0d586ff4-924f-44ac-a7bd-8b2507929a38

📥 Commits

Reviewing files that changed from the base of the PR and between a2b0bf2 and fa20860.

📒 Files selected for processing: 1

• temoa/components/costs.py

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.

Walkthrough

The pv_to_annuity documentation now shows the numerator as (i(1+i)^N), matching the existing implementation. No executable behavior changed.

Changes

Annuity formula documentation

Layer / File(s)	Summary
Correct documented formula temoa/components/costs.py	The documented numerator changes from (i + (1+i)^N) to (i(1+i)^N). The implementation is unchanged.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other · Severity of issue fixed: Low

Suggested reviewers: idelder

Merge Risk: ⚪ Minimal · up to fa208

The documented annuity formula is corrected without changing calculations, so no concrete merge-blocking risk remains.

Pre-merge checks: 5

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the documentation-only correction to the pv_to_annuity formula in the docstring.
Linked Issues check		Issue #384 requires a documentation-only correction in pv_to_annuity. The pull request changes the numerator from i + (1+i)^N to i(1+i)^N in temoa/components/costs.py. The summary also confirm…
Out of Scope Changes check		The change is limited to the documented formula in temoa/components/costs.py. The summary reports one documentation line changed and no executable behavior changes. This change supports issue #384 a…
Docstring Coverage		Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files.

Full details: Linked Issues check

Explanation

Issue #384 requires a documentation-only correction in pv_to_annuity. The pull request changes the numerator from i + (1+i)^N to i(1+i)^N in temoa/components/costs.py. The summary also confirms that the existing implementation already uses the correct expression.

Full details: Out of Scope Changes check

Explanation

The change is limited to the documented formula in temoa/components/costs.py. The summary reports one documentation line changed and no executable behavior changes. This change supports issue #384 and introduces no demonstrated unrelated work.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[idelder]

Good catch