Cli, Cli.Test module doc updates
This commit is contained in:
		
							parent
							
								
									6b280d8970
								
							
						
					
					
						commit
						b584f33cbb
					
				@ -1,6 +1,10 @@
 | 
				
			|||||||
{-| 
 | 
					{-| 
 | 
				
			||||||
Hledger.Cli re-exports the options, utilities and commands provided by the
 | 
					
 | 
				
			||||||
hledger command-line program.
 | 
					Hledger.Cli re-exports the options, utilities and commands provided by
 | 
				
			||||||
 | 
					the hledger command-line program. This module also aggregates the
 | 
				
			||||||
 | 
					built-in unit tests defined throughout hledger and hledger-lib, and
 | 
				
			||||||
 | 
					adds some more which are easier to define here.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
-}
 | 
					-}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
module Hledger.Cli (
 | 
					module Hledger.Cli (
 | 
				
			||||||
@ -36,8 +40,7 @@ import Hledger.Cli.Options
 | 
				
			|||||||
import Hledger.Cli.Utils
 | 
					import Hledger.Cli.Utils
 | 
				
			||||||
import Hledger.Cli.Version
 | 
					import Hledger.Cli.Version
 | 
				
			||||||
 | 
					
 | 
				
			||||||
-- | hledger and hledger-lib's unit tests aggregated from all modules
 | 
					
 | 
				
			||||||
-- plus some more which are easier to define here for now.
 | 
					 | 
				
			||||||
tests_Hledger_Cli :: Test
 | 
					tests_Hledger_Cli :: Test
 | 
				
			||||||
tests_Hledger_Cli = TestList
 | 
					tests_Hledger_Cli = TestList
 | 
				
			||||||
 [
 | 
					 [
 | 
				
			||||||
 | 
				
			|||||||
@ -1,28 +1,6 @@
 | 
				
			|||||||
{- |
 | 
					{- |
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This module contains hledger's unit tests. These are built in to hledger,
 | 
					A simple test runner for hledger's built-in unit tests.
 | 
				
			||||||
and can be run at any time by doing @hledger test@ (or, with a few more
 | 
					 | 
				
			||||||
options, by doing @make unittest@ in the hledger source tree.)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Other kinds of tests:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
hledger's functional tests are a set of shell/command-line tests defined
 | 
					 | 
				
			||||||
by .test files in the tests\/ subdirectory. These can be run by doing
 | 
					 | 
				
			||||||
@make functest@ in the hledger source tree.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
hledger's doctests are shell commands with expected output in literal
 | 
					 | 
				
			||||||
blocks in the haddock documentation, run by doing @make doctest@ in the
 | 
					 | 
				
			||||||
hledger source tree. They are hardly used, but here is an example:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@
 | 
					 | 
				
			||||||
$ bin\/hledger -f data\/sample.journal balance o
 | 
					 | 
				
			||||||
                  $1  expenses:food
 | 
					 | 
				
			||||||
                 $-2  income
 | 
					 | 
				
			||||||
                 $-1    gifts
 | 
					 | 
				
			||||||
                 $-1    salary
 | 
					 | 
				
			||||||
--------------------
 | 
					 | 
				
			||||||
                 $-1
 | 
					 | 
				
			||||||
@
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
-}
 | 
					-}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
		Reference in New Issue
	
	Block a user