From b37ea47e5d56adf1cf7320fe40fe036c64284b79 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Hru=C5=A1ka?= Date: Wed, 25 Apr 2018 22:54:26 +0200 Subject: [PATCH] note baout returning self --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 79b01c4..740be59 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,9 @@ samples is an array of record when the abalnce changed that we cna plot using th ProFin works with two types of objects: the profiler, and incomes. Expense is a negative income and is internally represented the same way. +Generally all methods return the object itself for easy chaining, with the exception of Projector methods like `monthly`, `single` etc, +which are shortcuts for creating income instances. + ### Projector API - `pf.date(year, month, day)` - set time cursor. This is used for subsequently created incomes as a starting date, or @@ -118,9 +121,9 @@ represented the same way. ### MonthlyIncome API -- `mi.on(day)` - set the pay day in the month, returns self -- `mi.skip_month(year, month)` - skip a month's payment, return self -- `mi.start(year, month, day)` - set start date (month, day default to Jan 1), return self. +- `mi.on(day)` - set the pay day in the month +- `mi.skip_month(year, month)` - skip a month's payment +- `mi.start(year, month, day)` - set start date (month, day default to Jan 1) If no args given, take current cursor's date - `mi.end(year, month, day)` - end the payments. If no args given, take last day of current cursor's month - `mi.total(total)` - set a total money cap, after it's exhausted the payments stop