slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

close: fix and document some newline issues

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2019-01-22 14:10:37 -08:00
parent 2f2b68f1cd
commit ede41af4c8
2 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
hledger/Hledger/Cli/Commands/Close.md
View File

@ -1,11 +1,8 @@
close, equity
Prints a "closing balances" transaction and an "opening balances" transaction,
Prints a "closing balances" transaction and an "opening balances" transaction
that bring account balances to and from zero, respectively.
Useful for, eg:
- bringing asset/liability balances forward into a new journal file
- closing out revenues/expenses to retained earnings at the end of a period
Useful for bringing asset/liability balances forward into a new journal file,
or for closing out revenues/expenses to retained earnings at the end of a period.
_FLAGS_

15
hledger/Hledger/Cli/Commands/README
View File

@ -11,12 +11,21 @@ It has some special features:
as space or comma-separated words.
- A line containing just _FLAGS_ will be replaced in --help output by
the command's flags list. If there's no such line, the flags will be
displayed at the end. In the manual, no flags list is shown.
the command's flags list. Lines above _FLAGS_ are known as the short help.
If there's no such line, the flags will be displayed at the end.
In the manual, no flags list is shown.
- Markdown can be used to influence the appearance of the manuals,
especially the html version. But the markup will also appear
uninterpreted in the --help output, so use sparingly.
- GHC (and ghcid etc.) won't notice changes in this file;
- Use only one newline on the first line (or cmdargs will display the
short help with two newlines after each line). This also means
cmdargs will strip out any blank lines, which prevents use of some
markdown features.
- Keep the width of short help lines to 76 characters or less, or
cmdargs will insert newlines.
- GHC, stack, cabal, ghcid etc. won't notice changes in this file;
you have to also touch the .hs file.