Commit graph

261 commits

Author SHA1 Message Date
Alexis Hildebrandt
012ce5ef10 [doc] Add documentation on running and writing tests
Minor wording edit
[ci skip]

Signed-off-by: Alexis Hildebrandt <afh@surryhill.net>
2015-01-15 14:53:17 +01:00
Alexis Hildebrandt
01252035cd [doc] Add CheckTests to ctest
to check whether all available ledger options documented
and are being tested.

Signed-off-by: Alexis Hildebrandt <afh@surryhill.net>
2015-01-15 14:53:16 +01:00
Steve Purcell
d5c1e05a59 Merge remote-tracking branch 'refs/remotes/ledger/master' into next 2015-01-14 18:37:45 +00:00
aleksejrs
b7190a69a8 Typo in the manual: "legder" 2015-01-14 20:42:16 +03:00
Alexis Hildebrandt
3a1ab67092 [tests] Fix new DocTest A9349E4 2015-01-10 15:27:24 +01:00
Alexis Hildebrandt
793e295a92 [tests] Validate another example in the manual 2015-01-10 14:06:32 +01:00
Alexis Hildebrandt
ca8eded48e [doc] Minor typographical and error corrections
[ci skip]
2015-01-05 14:14:25 +01:00
Alexis Hildebrandt
8946454b61 [doc] Bump Ledger version to 3.1
It would be great to use texinfo variables to set the current Ledger
version, e.g. @value{Ledger_VERSION_MAJOR} and pass the CMake variables
to texi2pdf via --command='@set Ledger_VERSION_MAJOR ${Ledger_VERSION_MAJOR}'.

Unfortunately texi2pdf will err with:
Argument of @parseargline has an extra }.
<inserted text> 
                @par 
<to be read again> 
                   }
@\subtitle ...epage {@subtitlefont @rightline {#1}
                                                  }
l.153 @subtitle For Version @value{Ledger_VERSION_MAJOR} of Ledger


[ci skip]
2015-01-05 14:13:38 +01:00
Alexis Hildebrandt
0669ca9b40 [doc] Update explanation for validating doc examples 2015-01-05 14:13:37 +01:00
Alexis Hildebrandt
6bd2c0e3f6 [doc] Bump copyright notice to 2015
[ci skip]
2015-01-05 14:13:37 +01:00
Alexis Hildebrandt
bf4dc7c8f4 [doc] Add whitespace to separate debug options
better from one another in the item list

[ci skip]
2015-01-05 14:13:37 +01:00
Alexis Hildebrandt
642ca8d9d6 [doc] Update list of debug codes
using ag --nogroup '^[        ]*debug\(' | cut -d '"' -f2 | sort -u | column

[ci skip]
2015-01-05 14:13:37 +01:00
thdox
77b5d0aee0 Indented with Emacs: M-x fill-paragraph 2014-12-22 10:01:57 +01:00
thdox
9b76c22f44 Document that buffer names should use @file{} keyword 2014-12-22 10:01:57 +01:00
thdox
66265e76d5 M-x delete-trailing-whitespace 2014-12-22 10:01:57 +01:00
thdox
c0a8ff7160 Fixes for consistency 2014-12-22 10:01:57 +01:00
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