Commit graph

245 commits

Author SHA1 Message Date
thdox
0af31f6d6a pxref already contains "see" 2014-12-22 10:01:57 +01:00
thdox
20471cf74b query is a command 2014-12-22 10:01:57 +01:00
thdox
9651f78c37 Minor fix: double spaces 2014-12-22 10:01:57 +01:00
thdox
81ac9b27fd fix minor typo 2014-12-22 10:01:47 +01:00
Steve Purcell
9ecf0cbadb Fix typo in docs 2014-12-15 18:43:32 +00:00
Alexis Hildebrandt
31ccb6d368 Fix and re-enable DocTests 2014-11-29 09:06:14 +01:00
myqlarson
5df0788ba2 Update ledger3.texi
Improved wording
2014-10-20 02:01:18 +13:00
myqlarson
cff5b16f7c Update ledger3.texi
Fixed typos and clarified CSV import behaviour with regard to column headers (I haven't checked the code, but I noticed the programme behaves this way).
2014-10-20 01:17:16 +13:00
Martin Michlmayr
325f8cb644 Fix numbers from example
Thanks to Dominik Honnef.
2014-10-17 21:22:02 -04:00
Martin Michlmayr
5eb6297042 Typo fix
Thanks to Dominik Honnef for spotting it.
2014-10-17 21:16:15 -04:00
Martin Michlmayr
acf0618fd0 Fix texinfo syntax errors
Fix the following texinfo syntax errors:

ledger/doc/ledger3.texi:7878: @itemx must follow @item
ledger/doc/ledger3.texi:7939: @itemx must follow @item
ledger/doc/ledger3.texi:7944: @itemx must follow @item
2014-10-12 16:52:43 -04:00
Redstreet
c5980f7491 Fix to 90519fc6e132bd (moved paragraph to end of section). 2014-07-03 14:42:54 -07:00
Redstreet
ba10ebbe73 Updated out of date value expression section in the documentation. 2014-07-03 14:24:39 -07:00
Martin Michlmayr
b1a6d2ce16 Document --values 2014-06-30 19:15:35 -04:00
Martin Michlmayr
3bf82068b4 Document --unrealized 2014-06-30 19:10:36 -04:00
thdox
b9781d3156 Fix minor typo 2014-06-22 15:49:21 +02:00
Martin Michlmayr
365781433c Fix minor formatting issue 2014-06-06 17:06:32 -04:00
Martin Michlmayr
f32fced494 Improve consistency regarding options
Use --exchange for both cases to avoid confusion for those who don't
know that --exchange and -X are the same.
2014-06-06 17:00:02 -04:00
Bradley M. Kuhn
bb59564b79 Document --exchange COMMODITY1:COMMODITY2 syntax.
It appears this syntax does indeed work as described in this change, but the
feature was not previously documented herein.
2014-06-05 08:17:47 -04:00
Martin Michlmayr
a5ffcc42ff Improve backwards compatibility with ledger2
This brings some single character format strings in line with what
they actually meant in ledger2.

Bug fix for #755
2014-05-30 23:52:36 -04:00
Martin Michlmayr
53b8aa8802 Remove character that wasn't displayed in ledger2 2014-05-30 23:17:03 -04:00
Ryan Nowakowski
ed9cc46b49 Fix python example so it runs 2014-05-15 21:29:54 -05:00
Christophe Rhodes
798eac3c6f document payee uuid subdirective 2014-05-13 16:24:46 +01:00
Jamie Nguyen
507fac7e50 Fix @node pointer errors
Unfortunately, you cannot reliably use periods, commas, or colons within
a node name; these can confuse the Info reader.
2014-04-27 19:41:59 +01:00
Peter Feigl
4239c284f1 finished first proof-reading of ledger manual 2014-03-14 11:24:12 +01:00
Peter Feigl
fca30d93f1 proof-reading the manual 2014-03-14 09:58:40 +01:00
Peter Feigl
c445a0ffc4 fixing typos and smaller errors in the ledger manual 2014-03-10 13:31:02 +01:00
Peter Feigl
5d7a9b0504 Fixing typos in documentation 2014-03-05 14:49:00 +01:00
Peter Feigl
a7034b68a1 Merge commit '4966c7f' into update-docs 2014-03-04 15:02:11 +01:00
Peter Feigl
4966c7f100 Fixing typos, adding @c input:validate to code examples 2014-03-04 15:01:23 +01:00
Peter Feigl
3e29a992e5 removing two new test cases that fail on travis. cannot reproduce failure 2014-03-04 11:12:31 +01:00
Peter Feigl
831c064c38 Added support for validation tests to DocTest.py (input:validate and
command:validate)

It is now possible to use @smallexample @c input:validate (and
command:validate) to specify that an example should just be read by
ledger (and checked for errors) or that a ledger command should be
executed (with default input -f sample.dat, if none is specified).

These annotations have been added into ledger3.texi where appropriate.

Running the ledger3.texi test now takes a second or two, but a lot of
the @smallexamples are now automatically tested.
2014-03-04 10:05:09 +01:00
Craig Earls
08f0735e1c Merge pull request #251 from ecraven/update-docs
first changes in adding more testable examples to ledger3.texi

These look good.  Could you put a brief explanation somewhere (not necessarily in ledger3.texi) on how to generate new tests? I should probably know where the command and input id numbers come from, but I don't.
2014-03-03 14:53:47 -07:00
Peter Feigl
479cdf4fe2 first changes in adding more testable examples to ledger3.texi 2014-03-03 22:36:06 +01:00
Peter Feigl
977af3d27c Adding documentation of options to man-page from manual. Fixing a few minor typos and mistakes. 2014-02-27 10:24:38 +01:00
Peter Feigl
ecd5097d51 Adding option --no-aliases to completely disable alias expansion 2014-02-26 23:50:50 +01:00
Peter Feigl
75b0a5d8ff Adding option --recursive-aliases, adding documentation to man-page and manual 2014-02-26 09:29:31 +01:00
Peter Feigl
c80b495546 Adding support for recursive aliases.
Alias expansion is now a loop. If you define

alias A=B:A
alias B=C:B

then A will expand to C:B:A.

Also added a short section to the manual about this.
2014-02-25 22:50:20 +01:00
Luke Williams
dacb5f9823 Fixing typo: test sweet -> test suite 2014-02-23 00:02:22 +10:00
Alexis Hildebrandt
3d9faef448 DocTests: Allow inline input to be used with different example commands 2014-02-19 06:52:43 +01:00
Alexis Hildebrandt
90988feebc DocTests: Allow multiple example inputs
to be used as single ledger data for an example command
2014-02-19 06:52:43 +01:00
Matijs van Zuijlen
59fde5e777 Implicit logical and is really a logical or 2014-02-17 07:25:07 +01:00
Craig Earls
c59aadaace Merge pull request #241 from afh/pull/spelling
Correct minor spelling mistakes and improve spellcheck.sh

Awesome.
2014-02-09 11:32:44 -07:00
Alexis Hildebrandt
a2f86c85df Add explanation on how to validate documentation examples
by specially marking @smallexample, which will be used by DocTests.py
2014-02-09 07:54:27 +01:00
Alexis Hildebrandt
a1cc8ca15a Add support to check documentation examples with inline data 2014-02-07 18:39:35 +01:00
Alexis Hildebrandt
c73ba9d075 Correct spelling mistakes 2014-02-07 00:23:22 +01:00
Alexis Hildebrandt
fbbb379fe0 Check examples in documentation when running tests
The DocTests.py script will parse a given texinfo file for specially
marked examples, run the ledger command from the example, and check
the result against the example output from the documentation.
2014-02-07 00:21:38 +01:00
Alexis Hildebrandt
df9771f7a9 Bump copyright notice to 2014 in the documentation 2014-02-04 21:58:03 +01:00
Steve Purcell
d7742cd654 Commodity column in default CSV format should match the displayed amount
If one uses --exchange to force CSV display amounts into a particular
currency, then the commodity output column should match that currency.

Without this patch, the commodity column contains the original
commodity, not the commodity for the exported amount.
2014-01-06 17:37:04 +00:00
Alan Berndt
b23616abc0 Fix reference to old pattern negation syntax 2013-09-24 12:54:32 -07:00