doc: force a line break after command names in new command docs

[ci skip]
This commit is contained in:
Simon Michael 2019-01-26 16:31:41 -08:00
parent a37c18e5c7
commit 817497f30b
5 changed files with 84 additions and 73 deletions

View File

@ -1,4 +1,4 @@
close, equity 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. that bring account balances to and from zero, respectively.
Useful for bringing asset/liability balances forward into a new journal file, Useful for bringing asset/liability balances forward into a new journal file,

View File

@ -8,7 +8,12 @@ and by hledger/hledger_commands.m4.md to help build the hledger manual.
It has some special features: It has some special features:
- The first line should specify the command name and any aliases, - 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 - 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. the command's flags list. Lines above _FLAGS_ are known as the short help.

View File

@ -2455,9 +2455,12 @@ Report account names having the same leaf but different prefixes.
An example: http://stefanorodighiero.net/software/hledger\-dupes.html An example: http://stefanorodighiero.net/software/hledger\-dupes.html
.SS close .SS close
.PP .PP
close, equity Prints a "closing balances" transaction and an "opening close, equity
balances" transaction that bring account balances to and from zero, .PD 0
respectively. .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 Useful for bringing asset/liability balances forward into a new journal
file, or for closing out revenues/expenses to retained earnings at the file, or for closing out revenues/expenses to retained earnings at the
end of a period. end of a period.

View File

@ -1969,11 +1969,13 @@ File: hledger.info, Node: close, Next: files, Prev: check-dupes, Up: COMMAND
4.10 close 4.10 close
========== ==========
close, equity Prints a "closing balances" transaction and an "opening close, equity
balances" transaction that bring account balances to and from zero,
respectively. Useful for bringing asset/liability balances forward into Prints a "closing balances" transaction and an "opening balances"
a new journal file, or for closing out revenues/expenses to retained transaction that bring account balances to and from zero, respectively.
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.
The closing transaction transfers balances to "equity:closing The closing transaction transfers balances to "equity:closing
balances". The opening transaction transfers balances from balances". The opening transaction transfers balances from
@ -2835,63 +2837,63 @@ Node: check-dupes66420
Ref: #check-dupes66544 Ref: #check-dupes66544
Node: close66681 Node: close66681
Ref: #close66789 Ref: #close66789
Node: files70203 Node: files70206
Ref: #files70304 Ref: #files70307
Node: help70445 Node: help70448
Ref: #help70545 Ref: #help70548
Node: import71619 Node: import71622
Ref: #import71733 Ref: #import71736
Node: incomestatement72463 Node: incomestatement72466
Ref: #incomestatement72597 Ref: #incomestatement72600
Node: prices75001 Node: prices75004
Ref: #prices75116 Ref: #prices75119
Node: print75388 Node: print75391
Ref: #print75498 Ref: #print75501
Node: print-unique80392 Node: print-unique80395
Ref: #print-unique80518 Ref: #print-unique80521
Node: register80586 Node: register80589
Ref: #register80713 Ref: #register80716
Node: Custom register output85214 Node: Custom register output85217
Ref: #custom-register-output85343 Ref: #custom-register-output85346
Node: register-match86573 Node: register-match86576
Ref: #register-match86707 Ref: #register-match86710
Node: rewrite86890 Node: rewrite86893
Ref: #rewrite87005 Ref: #rewrite87008
Node: roi87074 Node: roi87077
Ref: #roi87172 Ref: #roi87175
Node: stats87288 Node: stats87291
Ref: #stats87387 Ref: #stats87390
Node: tags88257 Node: tags88260
Ref: #tags88355 Ref: #tags88358
Node: test88591 Node: test88594
Ref: #test88675 Ref: #test88678
Node: ADD-ON COMMANDS89383 Node: ADD-ON COMMANDS89386
Ref: #add-on-commands89493 Ref: #add-on-commands89496
Node: Official add-ons90780 Node: Official add-ons90783
Ref: #official-add-ons90920 Ref: #official-add-ons90923
Node: api91007 Node: api91010
Ref: #api91096 Ref: #api91099
Node: ui91148 Node: ui91151
Ref: #ui91247 Ref: #ui91250
Node: web91305 Node: web91308
Ref: #web91394 Ref: #web91397
Node: Third party add-ons91440 Node: Third party add-ons91443
Ref: #third-party-add-ons91615 Ref: #third-party-add-ons91618
Node: diff91750 Node: diff91753
Ref: #diff91847 Ref: #diff91850
Node: iadd91946 Node: iadd91949
Ref: #iadd92060 Ref: #iadd92063
Node: interest92143 Node: interest92146
Ref: #interest92264 Ref: #interest92267
Node: irr92359 Node: irr92362
Ref: #irr92457 Ref: #irr92460
Node: Experimental add-ons92588 Node: Experimental add-ons92591
Ref: #experimental-add-ons92740 Ref: #experimental-add-ons92743
Node: autosync93020 Node: autosync93023
Ref: #autosync93131 Ref: #autosync93134
Node: chart93370 Node: chart93373
Ref: #chart93489 Ref: #chart93492
Node: check93560 Node: check93563
Ref: #check93662 Ref: #check93665
 
End Tag Table End Tag Table

View File

@ -1756,11 +1756,12 @@ COMMANDS
example: http://stefanorodighiero.net/software/hledger-dupes.html example: http://stefanorodighiero.net/software/hledger-dupes.html
close close
close, equity Prints a "closing balances" transaction and an "opening close, equity
balances" transaction that bring account balances to and from zero, Prints a "closing balances" transaction and an "opening balances"
respectively. Useful for bringing asset/liability balances forward transaction that bring account balances to and from zero, respectively.
into a new journal file, or for closing out revenues/expenses to Useful for bringing asset/liability balances forward into a new journal
retained earnings at the end of a period. 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- The closing transaction transfers balances to "equity:closing bal-
ances". The opening transaction transfers balances from "equity:open- ances". The opening transaction transfers balances from "equity:open-