DOC: clarify pmt cash-flow signs - #157
Open
naseweisssss wants to merge 2 commits into
Open
naseweisssss wants to merge 2 commits into
naseweisssss wants to merge 2 commits into
Conversation
Member
There was a problem hiding this comment.
Thanks for working on this, @naseweisssss !
The zero rate example is a great idea, it's much easier to do the math. I checked against the implementation, and it's right.
A few small requests:
- Keep "Future value" as the term for
fv. That is the terminology used throughout the API:pv,nper,ipmt,ppmt,rate- all document thefvparameter as “Future value”. Also,fvitself is defined as computing the future value. Renaming it only inpmtwould introduce an inconsistency. - Make the
pvnote perspective-independent, e.g., "Cash received is positive and cash paid out is negative. For a borrower, the loan amount is positive". ipmt,ppmt,nper, andfvshare the same convention and descriptions. A short note in the module docstring explaining the convention would be nice. Also could be a follow-up PR.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add some documentations in relation to issues #130 to clarify the usage of signs on fv and pv