Commit Graph

64 Commits

Author SHA1 Message Date
Simon Michael
cca95d2974 doc: update builtin manuals 2017-06-15 19:16:39 -07:00
Simon Michael
e119941648 rename "uncleared" status to "unmarked" and --uncleared to --unmarked (#564)
See the issue and linked mail list discussion. Ambiguity between the
uncleared state, and the "not cleared" --uncleared flag causes confusion
and friction. At this point it seems best to break with Ledger and
past hledger, pick a new name and drop --uncleared to put an end to it.
2017-06-15 19:16:39 -07:00
Simon Michael
794647780d doc: fixes for builtin manuals 2017-06-15 19:16:39 -07:00
Simon Michael
d0771a8526 doc: regenerate builtin manuals 2017-06-15 19:16:39 -07:00
Simon Michael
f168d74010 doc: update status docs 2017-06-15 19:16:39 -07:00
Simon Michael
1755f71202 bump version/month in all generated docs 2017-06-06 09:22:39 -07:00
Joe Horsnell
35f77ee5e4 Fix trivial typo (#balance-assertions anchor) in CSV docs. (#559) 2017-05-30 07:27:14 -07:00
Simon Michael
dca7ffc10b doc: journal: meaning of --uncleared, matching tips (#553)
[ci skip]
2017-05-24 19:17:29 -07:00
Simon Michael
34af40024a doc: journal: expand transactions/postings/status sections (#553) 2017-05-24 17:44:32 -07:00
Simon Michael
a5b545c4eb doc: clarify some transaction price details
- remove inaccurate print examples
- note #551
- note Ledger's fixed price syntax
- note how posting order can affect -B
- edits for clarity
2017-05-22 17:52:14 -07:00
Jan Zerebecki
f403b1e709 Fix link to queries (#550) 2017-05-22 07:29:55 -07:00
Simon Michael
2ac77338f8 doc: csv tweaks 2017-04-19 09:04:44 -07:00
Dmitry Astapov
451f9d7307 "balance" parser for csv reader (#537)
* "balance" parser for csv reader

* Some docs for
2017-04-14 14:52:03 -07:00
Simon Michael
f9ad13b1c1 doc: journal: drop obsolete info 2017-04-13 08:42:52 -07:00
Simon Michael
d9488ea01b doc: move cost/market value into general options section
[ci skip]
2017-03-31 19:18:17 -07:00
Simon Michael
6ee66979ff doc: regenerate files 2017-03-31 18:01:32 -07:00
Simon Michael
61a5b5274b doc: journal: fix link to aliases howto
[ci skip]
2017-03-31 10:42:53 -07:00
Simon Michael
59704dcb6b doc: regenerate doc files 2017-03-27 05:12:03 -07:00
Justin Le
600132445c documentation changed to reflect new bs/is/cf and -V behavior 2017-02-04 16:38:18 -08:00
Simon Michael
0395543719 doc: journal: market price doc tweak 2017-01-26 14:19:23 -08:00
Simon Michael
9759b5c867 doc: clarify tags
[ci skip]
2017-01-16 16:26:51 -08:00
Simon Michael
91dbeedee4 doc: document new --pivot
[ci skip]
2017-01-16 15:53:51 -08:00
Simon Michael
d657374ac4 doc: note an issue with balance assertions & multiple -f options
[ci skip]
2017-01-14 17:49:26 -08:00
Simon Michael
3ae8712bbc rename data/ to examples/ 2017-01-08 07:26:13 -08:00
Simon Michael
fe457fa12a doc: update built-in docs 2017-01-05 10:43:06 -08:00
Simon Michael
dd86596d30 doc: rename _versions_ macro 2017-01-04 10:50:16 -08:00
Simon Michael
6072f2a8f4 doc: update generated doc files 2016-12-31 11:23:53 -08:00
Simon Michael
78f0c403fb doc: update generated docs 2016-12-30 14:36:27 -08:00
Simon Michael
701fb5496f doc, cli: improvements for -B, -V, prices docs #403 2016-12-30 14:36:27 -08:00
Simon Michael
547e6d5438 doc: journal: clarify market prices (#403) 2016-12-29 12:39:39 -08:00
Simon Michael
47ca1965b2 doc: document balance assignments (#438) 2016-12-10 08:03:56 -08:00
Simon Michael
c8fefef7e8 doc: document file reading, and some options cleanups 2016-11-18 13:26:15 -08:00
Simon Michael
315db5621a doc: bump version to 1.0, update manuals & cabal files 2016-10-26 13:34:27 -07:00
Simon Michael
bdf8f5ca88 doc: update generated docs, fixing typos 2016-10-20 16:57:35 -07:00
Simon Michael
86c23bde7f doc: journal: fix posting dates link (fixes #401)
[ci skip]
2016-09-14 06:57:44 -07:00
Simon Michael
233251b06a doc: journal: clarify D directive
Example added, per #399 discussion.
2016-09-13 09:11:08 -07:00
Simon Michael
7aa23f6ca2 doc: update generated manuals, and show 0.28dev there 2016-08-08 06:49:50 -07:00
Simon Michael
2bee53af96 doc: updated generated manuals 2016-08-02 12:55:14 -07:00
Simon Michael
63b9f288f5 doc: csv: small rewordings 2016-07-21 19:47:34 -07:00
Simon Michael
68a1a8687a doc: generate really plain text manuals
Drop the nice ansi highlighting that won't work everywhere,
the unpredictable unicode hyphens, etc.
2016-06-11 21:34:20 -07:00
Simon Michael
54571ede20 doc: journal: describe postings & their cleared flag 2016-06-03 10:21:09 -07:00
Simon Michael
df07ad0109 doc: parameterise and bump docs version to 0.28 2016-05-28 23:31:44 -07:00
Simon Michael
bd3212654c doc: bring embedded help files up to date 2016-05-28 12:58:30 -07:00
Simon Michael
84097b75c7 journal: can now include timeclock/timedot files (#320)
journal files can now include journal, timeclock or timedot files (but
not yet CSV files). Also timeclock/timedot files no longer support
default year directives.

The Hledger.Read.* modules have been reorganised for better reuse.
Hledger.Read.Utils has been renamed Hledger.Read.Common and holds
low-level parsers & utilities; high-level read utilities have moved to
Hledger.Read.
2016-05-17 19:46:54 -07:00
Simon Michael
89b1cd1e5b doc: readme for doc directories 2016-05-17 10:03:57 -07:00
Simon Michael
9197c0545f doc: journal: improve amount, virtual posting docs 2016-05-10 07:58:38 -07:00
Simon Michael
7a616d6779 doc: journal: commodity directive, amount formats (#295) 2016-05-08 21:10:58 -07:00
Simon Michael
e2ce7c4802 doc, tests: clarify what --date2 does 2016-05-06 16:57:24 -07:00
Simon Michael
856c0b3042 lib: fix bracketed posting dates, parser cleanup (#304)
Bracketed posting dates were fragile; they worked only if you wrote full
10-character dates. Also some semantics were a bit unclear. Now they
should be robust, and have been documented more clearly. This is a
legacy undocumented Ledger syntax, but it improves compatibility and
might be preferable to the more verbose "date:" tags if you write
posting dates often (as I do).

Internally, bracketed posting dates are no longer considered to be tags.
Journal comment, tag, and posting date parsers have been reworked, all
with doctests. Also the journal parser types generally have been
tightened up and clarified, making it much easier to know how to combine
and run them. There's now

-- | A parser of strings with generic user state, monad and return type.
type StringParser u m a = ParsecT String u m a

-- | A string parser with journal-parsing state.
type JournalParser m a = StringParser JournalContext m a

-- | A journal parser that runs in IO and can throw an error mid-parse.
type ErroringJournalParser a = JournalParser (ExceptT String IO) a

and corresponding convenience functions (and short aliases) for running them.
2016-04-28 13:34:57 -07:00
Simon Michael
80948d1db7 doc: also commit info files, should fix travis 2016-04-20 12:47:17 -07:00