From ede41af4c8ff5652fbb57ada6bac4c5a4b5e97d2 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 22 Jan 2019 14:10:37 -0800 Subject: [PATCH] close: fix and document some newline issues [ci skip] --- hledger/Hledger/Cli/Commands/Close.md | 9 +++------ hledger/Hledger/Cli/Commands/README | 15 ++++++++++++--- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/hledger/Hledger/Cli/Commands/Close.md b/hledger/Hledger/Cli/Commands/Close.md index 0db83eb1b..e8bd1d184 100644 --- a/hledger/Hledger/Cli/Commands/Close.md +++ b/hledger/Hledger/Cli/Commands/Close.md @@ -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_ diff --git a/hledger/Hledger/Cli/Commands/README b/hledger/Hledger/Cli/Commands/README index a26a45899..317d012e7 100644 --- a/hledger/Hledger/Cli/Commands/README +++ b/hledger/Hledger/Cli/Commands/README @@ -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.