diff options
| author | Justin St-Amant <jstamant@gmail.com> | 2023-09-20 08:22:04 -0500 |
|---|---|---|
| committer | Justin St-Amant <jstamant@gmail.com> | 2023-09-20 08:22:04 -0500 |
| commit | 833b799d682211774bea5f9e240eeceafe999f41 (patch) | |
| tree | 7a4a5ad63e51a642bc71ca44fb3cc4cd24191e6c | |
| parent | 4355c4faf157d5ef47b126286aa501742732708d (diff) | |
| download | fork-ledger-833b799d682211774bea5f9e240eeceafe999f41.tar.gz fork-ledger-833b799d682211774bea5f9e240eeceafe999f41.tar.bz2 fork-ledger-833b799d682211774bea5f9e240eeceafe999f41.zip | |
Minor documentation update - on posting comments and fixed some examples
Added to "Transactions and Comments" section 4.7.1 to indicate that
posting comments *must* be preceded by at least two spaces.
I also applied this rule consistently to the entire documentation, which
only required changes in 4 locations.
I don't think the `ledger` binary cares about spaces in front of posting
comments. I never noticed this until I tried using `ledger-mode`'s
`ledger-post-edit-amount`, which was causing issues with comments
that don't have the proper spacing.
| -rw-r--r-- | doc/ledger3.texi | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/doc/ledger3.texi b/doc/ledger3.texi index 83a8391f..7d86ef41 100644 --- a/doc/ledger3.texi +++ b/doc/ledger3.texi @@ -1672,7 +1672,7 @@ There are several forms of comments within a transaction, for example: 2011/12/11 Something Sweet ; German Chocolate Cake ; :Broke Diet: - Expenses:Food $10.00 ; Friends: The gang + Expenses:Food $10.00 ; Friends: The gang Assets:Credit Union:Checking @end smallexample @@ -2119,10 +2119,12 @@ The @code{ACCOUNT} may be surrounded by parentheses if it is a virtual posting, or square brackets if it is a virtual posting that must balance. The @code{AMOUNT} can be followed by a per-unit posting cost, by specifying @code{@@ AMOUNT}, or a complete -posting cost with @code{@@@@ AMOUNT}. Lastly, the @code{NOTE} may +posting cost with @code{@@@@ AMOUNT}. The @code{NOTE} may specify an actual and/or effective date for the posting by using the syntax @code{[ACTUAL_DATE]} or @code{[=EFFECTIVE_DATE]} or -@code{[ACTUAL_DATE=EFFECTIVE_DATE]} (@pxref{Virtual postings}). +@code{[ACTUAL_DATE=EFFECTIVE_DATE]} (@pxref{Virtual postings}). Lastly, +note that both the @code{AMOUNT} and @code{NOTE} must be preceded by +at least two whitespace characters. @item P @findex --download @@ -3987,7 +3989,7 @@ something like @cindex effective date of invoice @smallexample @c input:validate -2008/01/01=2008/01/14 Client invoice ; estimated date you'll be paid +2008/01/01=2008/01/14 Client invoice ; estimated date you'll be paid Assets:Accounts Receivable $100.00 Income: Client name @end smallexample @@ -3995,7 +3997,7 @@ something like Then, when you receive the payment, you change it to @smallexample @c input:validate -2008/01/01=2008/01/15 Client invoice ; actual date money received +2008/01/01=2008/01/15 Client invoice ; actual date money received Assets:Accounts Receivable $100.00 Income: Client name @end smallexample @@ -6716,7 +6718,7 @@ wrong value you can use metadata to specify the expected amount: @smallexample @c input:validate 2012-03-12 Paycheck - Income $-990; Expected:: $-1000.00 + Income $-990 ; Expected:: $-1000.00 Checking @end smallexample @@ -10438,7 +10440,7 @@ features, include automatic and virtual transactions, Assets:Checking 2011/01/19 Grocery Store - Expenses:Food:Groceries $ 44.00 ; hastag: not block + Expenses:Food:Groceries $ 44.00 ; hastag: not block Assets:Checking 2011/01/25 Bank |