aboutsummaryrefslogtreecommitdiff
path: root/docs/finbudg.5.scd
diff options
context:
space:
mode:
authorYaroslav de la Peña Smirnov <yps@yaroslavps.com>2020-12-08 01:46:12 +0300
committerYaroslav de la Peña Smirnov <yps@yaroslavps.com>2020-12-08 01:46:12 +0300
commitc9b64850eba97a08068ce6914a0d2fe50af49aa8 (patch)
treed2bdbd20000cbfe917e80e4b0737b9ec0e2296ac /docs/finbudg.5.scd
parentcc00db276c203bdcff9ca32d857d23e5dc61f400 (diff)
downloadfinbudg-master.tar.gz
finbudg-master.zip
updated docsHEADv0.3.0master
Diffstat (limited to 'docs/finbudg.5.scd')
-rw-r--r--docs/finbudg.5.scd19
1 files changed, 11 insertions, 8 deletions
diff --git a/docs/finbudg.5.scd b/docs/finbudg.5.scd
index 72bfd58..ae485c1 100644
--- a/docs/finbudg.5.scd
+++ b/docs/finbudg.5.scd
@@ -56,14 +56,17 @@ The expenses file should contain at the start the following keys:
*category*=String
The category to which this expense belongs. _Optional_.
- *shared*=uint32
- If more than one, then the amount of people this expense was
- shared with. _Optional_.
-
- *recurring*=bool
- Indicates if this is a recurring expense, i.e. one that
- repeats for each period of time. For example, electricity
- bills. _Optional_.
+ *shared*=array<String>
+ An list of names of the people that this expense is shared
+ with proportionally. If owed equals true, then you are not
+ part of this expense, and the people listed here owe you all
+ of this expense. _Optional_.
+
+ *owed*=boolean
+ A boolean value that indicates whether you paid for this for
+ another person or persons. If set to true, then shared
+ should contain at least one name. _Optional_.
+
# NOTES