Commit Graph

58 Commits

Author SHA1 Message Date
Simon Michael
40dc9b1db5 doc: make periodic txn example more robust; motivate 2 space rule 2019-01-14 15:36:22 -08:00
Simon Michael
70b11ed0a4 journal: make balance assertions exact again (#941)
Going with option 1b from the issue: calculated and asserted amounts
are compared exactly, disregarding display precision.
But now balance assertion failure messages show those exact amounts at
full precision, avoiding confusion.
2019-01-08 16:51:11 +00:00
Simon Michael
9acce249bb journal: balance assertion/precision doc tweaks (#941) 2019-01-07 08:33:01 +00:00
Simon Michael
c331be7f23 journal: clarify balance assertion/display precision more (#941) 2019-01-06 22:17:20 +00:00
Simon Michael
187fcf75ed journal: clarify balance assertion/display precision interaction
Surprisingly, balance assertions were checking to maximum precision,
which meant it was possible, with a display-precision-limiting
commodity directive, to have a failing assertion with the error
message showing asserted and actual amounts that looked the same.

Now we round the calculated account balance (but not the asserted
balance) to display precision before comparing. This should ensure
assertions always behave as you would expect from visual inspection.
2019-01-06 08:30:54 +00:00
Simon Michael
86a91c514d lib: disallow prices in balance assertions/assignments (fix #824)
(and in Ledger-style {=FIXEDLOTPRICES} )
2019-01-05 07:35:54 +00:00
Simon Michael
552783a06b doc: journal: rewrite balance assertions doc a little 2018-12-02 16:22:28 -08:00
Simon Michael
a2faa8dfbf journal: doc: move multicommodity assertions doc to right place 2018-11-25 21:05:55 -08:00
Alex Chen
e4cc6f31b9 lib: update periodic transaction entry in journal docs
- also specify the starting date in the example periodic transaction so
  that it lies on the first day of the week (it otherwise does not
  parse)
2018-11-22 14:09:32 -08:00
Simon Michael
a711ae60fb journal: doc: more detail on transaction modifiers (#928)
[ci skip]
2018-11-13 18:15:51 -08:00
Simon Michael
0f2a31bea7 docs: journal: account: a little bit more about sorting
[ci skip]
2018-10-15 12:07:44 -07:00
Simon Michael
4f2d9dde4c docs: journal: clarify transaction modifiers
[ci skip]
2018-10-12 09:12:06 -07:00
Simon Michael
51bf8cbccc docs: journal: account: a gotcha when changing builtin account types
[ci skip]
2018-10-11 16:16:33 -07:00
Simon Michael
a899f7924f docs: journal: account: update directives intro
[ci skip]
2018-10-11 15:53:06 -07:00
Simon Michael
e4215c094e doc: journal: document setting account types
[ci skip]
2018-10-09 14:24:59 -10:00
Simon Michael
278802e648 journal: Y affects dates in periodic transactions (fix #892) 2018-10-09 11:54:40 -07:00
Simon Michael
855bd54d19 budget: declaration and (actual) amount sorting for bal --budget
Account declaration-aware sorting is the default throughout hledger now.
2018-09-24 08:31:19 -10:00
Simon Michael
f2b4fca9b0 docs: journal: more account sorting updates
[ci skip]
2018-09-23 18:04:20 -10:00
Simon Michael
7a9ca5f6a9 docs: journal: more account sorting updates
[ci skip]
2018-09-23 17:55:21 -10:00
Simon Michael
477caa31c5 docs: journal: remove account code from example
[ci skip]
2018-09-23 17:48:19 -10:00
Simon Michael
3de8c11de1 journal: a new account sorting mechanism, and a bunch of sorting fixes
A bunch of account sorting changes that got intermingled.

First, account codes have been dropped. They can still be parsed and
will be ignored, for now. I don't know if anyone used them.
Instead, account display order is now controlled by the order of account
directives, if any. From the mail list:

  I'd like to drop account codes, introduced in hledger 1.9 to control
  the display order of accounts. In my experience,

  - they are tedious to maintain
  - they duplicate/compete with the natural tendency to arrange account
    directives to match your mental chart of accounts
  - they duplicate/compete with the tree structure created by account
    names

  and it gets worse if you think about using them more extensively,
  eg to classify accounts by type.

  Instead, I plan to just let the position (parse order) of account
  directives determine the display order of those declared accounts.
  Undeclared accounts will be displayed after declared accounts,
  sorted alphabetically as usual.

Second, the various account sorting modes have been implemented more
widely and more correctly. All sorting modes (alphabetically, by account
declaration, by amount) should now work correctly in almost all commands
and modes (non-tabular and tabular balance reports, tree and flat modes,
the accounts command). Sorting bugs have been fixed, eg #875.
Only the budget report (balance --budget) does not yet support sorting.

Comprehensive functional tests for sorting in the accounts and balance
commands have been added. If you are confused by some sorting behaviour,
studying these tests is recommended, as sorting gets tricky.
2018-09-22 21:45:07 -10:00
Simon Michael
4c268f4a93 doc: journal: fix Transaction Modifiers formatting
[ci skip]
2018-08-14 16:07:26 +01:00
Simon Michael
681039b387 doc: journal: fix Transaction Modifiers heading
[ci skip]
2018-08-14 16:05:06 +01:00
Simon Michael
481e2061d7 doc: journal: tweak mnemonics 2018-08-02 08:25:49 +01:00
Simon Michael
64bd88dd80 doc: journal: rename topic to Transaction Modifiers 2018-08-02 08:25:49 +01:00
Joseph Weston
1fca47cf18 lib: update documentation for globs in 'include' directive 2018-07-26 06:12:31 +01:00
Simon Michael
8d6667f698 lib: doc: forecast transaction dates tweak (#835)
[ci skip]
2018-07-04 09:48:32 +01:00
Simon Michael
0322638cf5 lib: doc: clarify how forecast transaction dates work (#835)
[ci skip]
2018-07-04 09:41:12 +01:00
Simon Michael
937333c2c1 doc: journal: more account codes limitations
[ci skip]
2018-06-27 12:42:05 +01:00
Simon Michael
2959356bd9 doc: journal: note another account codes limitation, in flat mode
[ci skip]
2018-06-27 12:19:25 +01:00
Simon Michael
35e68e23c5 doc: journal: clarify account aliases doc
[ci skip]
2018-06-27 11:44:26 +01:00
Simon Michael
6d215945b6 doc: journal: clarify account aliases doc
[ci skip]
2018-06-27 11:41:11 +01:00
Simon Michael
6924e8390c lib: journal: let alias/apply account affect account directives (#825) 2018-06-27 11:33:12 +01:00
Simon Michael
422f1084c9 doc: journal: note that non-regex alias directive is case sensitive
[ci skip]
2018-06-27 11:15:46 +01:00
Simon Michael
bc9375e4e5 lib: doc: journal: describe current directive semantics, finally
It's amazing how you can build, document, support and fix a thing for
years and not know what exactly it does. Directives are tricky.
Here is a pretty accurate description of their current behaviour,
determined by testing.
2018-06-20 19:41:28 -07:00
Simon Michael
26489765ef lib: manual updates
[ci skip]
2018-06-20 18:44:34 -07:00
Simon Michael
b04dc82125 lib: doc: journal: clarify periodic transactions
[ci skip]
2018-06-18 17:54:07 -07:00
Simon Michael
e3507ad944 lib: journal: allow descriptions/comments in periodic transactions
Also period expressions relative to today's date can now be used,
for what it's worth.
2018-06-12 16:41:36 -07:00
Simon Michael
7a4c3eea65 lib: doc: periodic/auto rule cleanups 2018-06-12 16:41:36 -07:00
Simon Michael
cfdde062eb clarify directive semantics 2018-05-03 21:20:29 -07:00
Simon Michael
18e5c9d5c9 doc: move market price docs under directives 2018-05-03 13:11:17 -07:00
Simon Michael
3ef11037b2 doc: journal: directives
[ci skip]
2018-05-01 10:50:38 -07:00
Simon Michael
59c804dac4 doc: journal: directives & periodic/automated cleanups 2018-04-29 18:02:16 -07:00
Simon Michael
53706bae66 doc: journal: fix heading level 2018-04-29 16:59:37 -07:00
Simon Michael
0b380971f7 journal: require a decimal point in commodity/format/D directives
A commodity directive that doesn't specify the decimal point character
increases ambiguity and the chance of misparsing numbers, especially
as it overrides all style information inferred from the journal amounts.
In some cases it caused amounts with a decimal point to be parsed as if
with a digit group separator so 1.234 became 1234.

We could augment it with extra info from the journal amounts, when available,
but it would still be possible to be ambiguous, and that won't be obvious.

A commodity directive is what we recommend to nail down the style.
It seems the simple and really only way to do this reliably is to require
an explicit decimal point character. Most folks probably do this already.

Unfortunately, it makes another potential incompatiblity with ledger and
beancount journals. But the error message will be clear and easy to
work around.
2018-04-20 21:56:06 -07:00
Dmitry Astapov
c7d86f3572 doc: mention that auto postings affect balances/amount inference (#729) 2018-04-17 14:33:32 -07:00
Wad
3a7f50b5c5 Update hledger_journal.m4.md
Update the location of the vim ledger support.
2018-04-07 00:24:04 +01:00
Martin Michlmayr
633ad4455f doc: update references to the faq
Update references to the FAQ in the documentation and on the web site.
2018-03-31 17:58:29 +01:00
Simon Michael
1c26a5b8b5 doc: layout fix (#704, #706)
[ci skip]
2018-03-31 03:38:58 +01:00
Simon Michael
61a16870ab doc: warn about digit group separators in scientific notation (#704, #706)
[ci skip]
2018-03-31 03:06:55 +01:00