From 31370bb65d5fe5323910602eea48e630a14ed91e Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 21 Jan 2025 23:22:34 -1000 Subject: [PATCH] ;doc: update command docs --- hledger/Hledger/Cli/Commands/Close.md | 4 +-- hledger/Hledger/Cli/Commands/Close.txt | 38 ++++++++++++++------------ hledger/Hledger/Cli/Commands/Print.md | 4 +-- hledger/Hledger/Cli/Commands/Print.txt | 4 +-- 4 files changed, 26 insertions(+), 24 deletions(-) diff --git a/hledger/Hledger/Cli/Commands/Close.md b/hledger/Hledger/Cli/Commands/Close.md index a7ed1ff7713..a96b0ca71ed 100644 --- a/hledger/Hledger/Cli/Commands/Close.md +++ b/hledger/Hledger/Cli/Commands/Close.md @@ -28,9 +28,9 @@ Flags: --round=TYPE how much rounding or padding should be done when displaying amounts ? none - show original decimal digits, - as in journal + as in journal (default) soft - just add or remove decimal zeros - to match precision (default) + to match precision hard - round posting amounts to precision (can unbalance transactions) all - also round cost amounts to precision diff --git a/hledger/Hledger/Cli/Commands/Close.txt b/hledger/Hledger/Cli/Commands/Close.txt index 2f009d4d62f..363e97a5e47 100644 --- a/hledger/Hledger/Cli/Commands/Close.txt +++ b/hledger/Hledger/Cli/Commands/Close.txt @@ -28,9 +28,9 @@ Flags: --round=TYPE how much rounding or padding should be done when displaying amounts ? none - show original decimal digits, - as in journal + as in journal (default) soft - just add or remove decimal zeros - to match precision (default) + to match precision hard - round posting amounts to precision (can unbalance transactions) all - also round cost amounts to precision @@ -64,10 +64,9 @@ correct account balances in each case. The earliest opening balances transaction sets correct starting balances, and any later closing/opening pairs will harmlessly cancel each other out. -The balances will be transferred to and from an equity account: -equity:opening/closing balances by default, You can override this by -declaring an account with type V/Conversion, or by using --close-acct -and/or --open-acct. +The balances will be transferred to and from +equity:opening/closing balances by default. You can override this by +using --close-acct and/or --open-acct. You can select a different set of accounts to close/open by providing an account query. Eg to add Equity accounts, provide arguments like @@ -75,10 +74,13 @@ assets liabilities equity or type:ALE. When migrating to a new file, you'll usually want to bring along the AL or ALE accounts, but not the RX accounts (Revenue, Expense). +Assertions will be added indicating and checking the new balances of the +closed/opened accounts. + The generated transactions will have a clopen: tag. If the main -journal's file name contains a number (eg a year number), the tag's -value will be that file name with the number incremented. Or you can -choose the tag value yourself, by using --clopen=TAGVAL. +journal's base file name contains a number (eg a year number), the tag's +value will be that base file name with the number incremented. Or you +can choose the tag value yourself, by using --clopen=TAGVAL. close --close @@ -116,19 +118,19 @@ recommended. close --retain -This is like --close, but with different defaults: it prints a -transaction that transfers Revenue and Expense balances to -equity:retained earnings (and adds a retain: tag). +This is like --close, but it closes Revenue and Expense account balances +by default. They will be transferred to equity:retained earnings, or +another account specified with --close-acct. -This is called "retaining earnings", or "closing the books". Revenues -and expenses correspond to changes in equity. They are initially kept -separate for reporting purposes, but traditionally at the end of each -accounting period, businesses consolidate them into equity, +Revenues and expenses correspond to changes in equity. They are +categorised separately for reporting purposes, but traditionally at the +end of each accounting period, businesses consolidate them into equity, +This is called "retaining earnings", or "closing the books". In personal accounting, there's not much reason to do this, and most -people don't. One reason to do it is to help the balancesheetequity +people don't. (One reason to do it is to help the balancesheetequity report show a zero total, demonstrating that the accounting equation -(A-L=E) is satisfied. +(A-L=E) is satisfied.) close customisation diff --git a/hledger/Hledger/Cli/Commands/Print.md b/hledger/Hledger/Cli/Commands/Print.md index 047e483216d..bf1869239fd 100644 --- a/hledger/Hledger/Cli/Commands/Print.md +++ b/hledger/Hledger/Cli/Commands/Print.md @@ -10,9 +10,9 @@ Flags: --round=TYPE how much rounding or padding should be done when displaying amounts ? none - show original decimal digits, - as in journal + as in journal (default) soft - just add or remove decimal zeros - to match precision (default) + to match precision hard - round posting amounts to precision (can unbalance transactions) all - also round cost amounts to precision diff --git a/hledger/Hledger/Cli/Commands/Print.txt b/hledger/Hledger/Cli/Commands/Print.txt index c8db7d46842..fa7542e3d00 100644 --- a/hledger/Hledger/Cli/Commands/Print.txt +++ b/hledger/Hledger/Cli/Commands/Print.txt @@ -9,9 +9,9 @@ Flags: --round=TYPE how much rounding or padding should be done when displaying amounts ? none - show original decimal digits, - as in journal + as in journal (default) soft - just add or remove decimal zeros - to match precision (default) + to match precision hard - round posting amounts to precision (can unbalance transactions) all - also round cost amounts to precision