From 817497f30b6d6c7c2644318a2598704a925d1b04 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sat, 26 Jan 2019 16:31:41 -0800 Subject: [PATCH] doc: force a line break after command names in new command docs [ci skip] --- hledger/Hledger/Cli/Commands/Close.md | 2 +- hledger/Hledger/Cli/Commands/README | 7 +- hledger/hledger.1 | 9 +- hledger/hledger.info | 128 +++++++++++++------------- hledger/hledger.txt | 11 ++- 5 files changed, 84 insertions(+), 73 deletions(-) diff --git a/hledger/Hledger/Cli/Commands/Close.md b/hledger/Hledger/Cli/Commands/Close.md index dfe004c8a..02cc3ecf0 100644 --- a/hledger/Hledger/Cli/Commands/Close.md +++ b/hledger/Hledger/Cli/Commands/Close.md @@ -1,4 +1,4 @@ -close, equity +close, equity\ Prints a "closing balances" transaction and an "opening balances" transaction that bring account balances to and from zero, respectively. Useful for bringing asset/liability balances forward into a new journal file, diff --git a/hledger/Hledger/Cli/Commands/README b/hledger/Hledger/Cli/Commands/README index 0605ed4fa..ebce1a849 100644 --- a/hledger/Hledger/Cli/Commands/README +++ b/hledger/Hledger/Cli/Commands/README @@ -8,7 +8,12 @@ and by hledger/hledger_commands.m4.md to help build the hledger manual. It has some special features: - The first line should specify the command name and any aliases, - as space or comma-separated words. + as space or comma-separated words, and be terminated by a backslash + (forcing a line break in the output). The help content should begin on line 2. + Eg: + + close, equity\ + Prints a "closing balances" transaction... - A line containing just _FLAGS_ will be replaced in --help output by the command's flags list. Lines above _FLAGS_ are known as the short help. diff --git a/hledger/hledger.1 b/hledger/hledger.1 index 14870ffe9..1b412481f 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -2455,9 +2455,12 @@ Report account names having the same leaf but different prefixes. An example: http://stefanorodighiero.net/software/hledger\-dupes.html .SS close .PP -close, equity Prints a "closing balances" transaction and an "opening -balances" transaction that bring account balances to and from zero, -respectively. +close, equity +.PD 0 +.P +.PD +Prints a "closing balances" transaction and an "opening balances" +transaction that bring account balances to and from zero, respectively. 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. diff --git a/hledger/hledger.info b/hledger/hledger.info index 3b43f8b8e..4791fddca 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -1969,11 +1969,13 @@ File: hledger.info, Node: close, Next: files, Prev: check-dupes, Up: COMMAND 4.10 close ========== -close, equity Prints a "closing balances" transaction and an "opening -balances" transaction that bring account balances to and from zero, -respectively. 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. +close, equity + + Prints a "closing balances" transaction and an "opening balances" +transaction that bring account balances to and from zero, respectively. +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. The closing transaction transfers balances to "equity:closing balances". The opening transaction transfers balances from @@ -2835,63 +2837,63 @@ Node: check-dupes66420 Ref: #check-dupes66544 Node: close66681 Ref: #close66789 -Node: files70203 -Ref: #files70304 -Node: help70445 -Ref: #help70545 -Node: import71619 -Ref: #import71733 -Node: incomestatement72463 -Ref: #incomestatement72597 -Node: prices75001 -Ref: #prices75116 -Node: print75388 -Ref: #print75498 -Node: print-unique80392 -Ref: #print-unique80518 -Node: register80586 -Ref: #register80713 -Node: Custom register output85214 -Ref: #custom-register-output85343 -Node: register-match86573 -Ref: #register-match86707 -Node: rewrite86890 -Ref: #rewrite87005 -Node: roi87074 -Ref: #roi87172 -Node: stats87288 -Ref: #stats87387 -Node: tags88257 -Ref: #tags88355 -Node: test88591 -Ref: #test88675 -Node: ADD-ON COMMANDS89383 -Ref: #add-on-commands89493 -Node: Official add-ons90780 -Ref: #official-add-ons90920 -Node: api91007 -Ref: #api91096 -Node: ui91148 -Ref: #ui91247 -Node: web91305 -Ref: #web91394 -Node: Third party add-ons91440 -Ref: #third-party-add-ons91615 -Node: diff91750 -Ref: #diff91847 -Node: iadd91946 -Ref: #iadd92060 -Node: interest92143 -Ref: #interest92264 -Node: irr92359 -Ref: #irr92457 -Node: Experimental add-ons92588 -Ref: #experimental-add-ons92740 -Node: autosync93020 -Ref: #autosync93131 -Node: chart93370 -Ref: #chart93489 -Node: check93560 -Ref: #check93662 +Node: files70206 +Ref: #files70307 +Node: help70448 +Ref: #help70548 +Node: import71622 +Ref: #import71736 +Node: incomestatement72466 +Ref: #incomestatement72600 +Node: prices75004 +Ref: #prices75119 +Node: print75391 +Ref: #print75501 +Node: print-unique80395 +Ref: #print-unique80521 +Node: register80589 +Ref: #register80716 +Node: Custom register output85217 +Ref: #custom-register-output85346 +Node: register-match86576 +Ref: #register-match86710 +Node: rewrite86893 +Ref: #rewrite87008 +Node: roi87077 +Ref: #roi87175 +Node: stats87291 +Ref: #stats87390 +Node: tags88260 +Ref: #tags88358 +Node: test88594 +Ref: #test88678 +Node: ADD-ON COMMANDS89386 +Ref: #add-on-commands89496 +Node: Official add-ons90783 +Ref: #official-add-ons90923 +Node: api91010 +Ref: #api91099 +Node: ui91151 +Ref: #ui91250 +Node: web91308 +Ref: #web91397 +Node: Third party add-ons91443 +Ref: #third-party-add-ons91618 +Node: diff91753 +Ref: #diff91850 +Node: iadd91949 +Ref: #iadd92063 +Node: interest92146 +Ref: #interest92267 +Node: irr92362 +Ref: #irr92460 +Node: Experimental add-ons92591 +Ref: #experimental-add-ons92743 +Node: autosync93023 +Ref: #autosync93134 +Node: chart93373 +Ref: #chart93492 +Node: check93563 +Ref: #check93665  End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index 1e55cd417..819c8621d 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -1756,11 +1756,12 @@ COMMANDS example: http://stefanorodighiero.net/software/hledger-dupes.html close - close, equity Prints a "closing balances" transaction and an "opening - balances" transaction that bring account balances to and from zero, - respectively. 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. + close, equity + Prints a "closing balances" transaction and an "opening balances" + transaction that bring account balances to and from zero, respectively. + 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. The closing transaction transfers balances to "equity:closing bal- ances". The opening transaction transfers balances from "equity:open-