sfos/ledger
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix documentation for apply fixed

Browse source 
The old "fixed" and "endfixed" are no longer used (and afaict don't
work).  You have to use "apply fixed" and "end apply" instead.

Fixes issue #789

Signed-off-by: Martin Michlmayr <tbm@cyrius.com>
This commit is contained in:
Martin Michlmayr 2018-06-01 17:36:49 +02:00
parent 882937ece2
commit e3fa7e9d89
No known key found for this signature in database
GPG key ID: 3D0787AAAF6C61DD
1 changed files with 35 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

78
doc/ledger3.texi
View file

@ -2255,6 +2255,41 @@ Would result in all postings going into
@samp{Personal:Expenses:Groceries} and @samp{Personal:Assets:Checking}
until an @samp{end apply account} directive was found.
@item apply fixed
@findex fixed
@cindex fixated prices
@c instance_t::fixed_directive in textual.cc
A fixed block is used to set fixated prices (@pxref{Fixated prices and
costs}) for a series of transactions. It's purely a typing saver, for
use when entering many transactions with fixated prices.
Thus, the following:
@smallexample @c input:validate
apply fixed CAD $0.90
2012-04-10 Lunch in Canada
Assets:Wallet -15.50 CAD
Expenses:Food 15.50 CAD
2012-04-11 Second day Dinner in Canada
Assets:Wallet -25.75 CAD
Expenses:Food 25.75 CAD
end apply fixed
@end smallexample
is equivalent to this:
@smallexample @c input:validate
2012-04-10 Lunch in Canada
Assets:Wallet -15.50 CAD @{=$0.90@}
Expenses:Food 15.50 CAD @{=$0.90@}
2012-04-11 Second day Dinner in Canada
Assets:Wallet -25.75 CAD @{=$0.90@}
Expenses:Food 25.75 CAD @{=$0.90@}
@end smallexample
@item alias
@findex alias
@cindex account, alias
@ -2442,49 +2477,6 @@ Closes block commands like @code{apply} or @code{comment}.
@findex expr
@c instance_t::expr_directive in textual.cc
@item fixed
@findex fixed
@cindex fixated prices
@c instance_t::fixed_directive in textual.cc
A fixed block is used to set fixated prices (@pxref{Fixated prices and
costs}) for a series of transactions. It's purely a typing saver, for
use when entering many transactions with fixated prices.
Thus, the following:
@smallexample @c input:validate
fixed CAD $0.90
2012-04-10 Lunch in Canada
Assets:Wallet -15.50 CAD
Expenses:Food 15.50 CAD
2012-04-11 Second day Dinner in Canada
Assets:Wallet -25.75 CAD
Expenses:Food 25.75 CAD
endfixed CAD
@end smallexample
is equivalent to this:
@smallexample @c input:validate
2012-04-10 Lunch in Canada
Assets:Wallet -15.50 CAD @{=$0.90@}
Expenses:Food 15.50 CAD @{=$0.90@}
2012-04-11 Second day Dinner in Canada
Assets:Wallet -25.75 CAD @{=$0.90@}
Expenses:Food 25.75 CAD @{=$0.90@}
@end smallexample
Note that ending a @code{fixed} is done differently than other
directives, as @code{fixed} is closed with an @code{endfixed} (i.e.,
there is @emph{no space} between @code{end} and @code{fixed}).
For the moment, users may wish to study
@uref{https://github.com/ledger/ledger/issues/789, Bug Report 789}
before using the @code{fixed} directive in production.
@item include
@findex include
@c instance_t::include_directive in textual.cc