Skip to content

Commit 7cffa63

Browse files
committed
Docs match new output.
1 parent 6cc5d01 commit 7cffa63

File tree

1 file changed

+25
-22
lines changed

1 file changed

+25
-22
lines changed

README.md

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,25 @@ user@host: ~/menu $ cargo run --example simple
1616
In enter_root()
1717
> help
1818
AVAILABLE ITEMS:
19-
foo <a> [ <b> ] [ --verbose ] [ --level=INT ] - Makes a foo appear.
20-
bar - fandoggles a bar
21-
sub - enter sub-menu
22-
help [ <command> ] - Show this help, or get help on a specific command.
19+
foo <a> [ <b> ] [ OPTIONS... ]
20+
bar
21+
sub
22+
help [ <command> ]
2323

2424

2525
> help foo
2626
SUMMARY:
27-
foo <a> [ <b> ] [ --verbose ] [ --level=INT ]
27+
foo <a> [ <b> ] [ --verbose ] [ --level=INT ]
2828

2929
PARAMETERS:
30-
<a>
31-
- This is the help text for 'a'
32-
<b>
33-
- No help text found
34-
--verbose
35-
- No help text found
36-
--level=INT
37-
- Set the level of the dangle
30+
<a>
31+
This is the help text for 'a'
32+
<b>
33+
No help text found
34+
--verbose
35+
No help text found
36+
--level=INT
37+
Set the level of the dangle
3838

3939

4040
DESCRIPTION:
@@ -63,20 +63,19 @@ Error: Too many arguments given
6363

6464
/sub> help
6565
AVAILABLE ITEMS:
66-
baz - thingamobob a baz
67-
quux - maximum quux
68-
exit - Leave this menu.
69-
help [ <command> ] - Show this help, or get help on a specific command.
70-
66+
baz
67+
quux
68+
exit
69+
help [ <command> ]
7170

7271
> exit
7372

7473
> help
7574
AVAILABLE ITEMS:
76-
foo <a> [ <b> ] [ --verbose ] [ --level=INT ] - Makes a foo appear.
77-
bar - fandoggles a bar
78-
sub - enter sub-menu
79-
help [ <command> ] - Show this help, or get help on a specific command.
75+
foo <a> [ <b> ] [ OPTIONS... ]
76+
bar
77+
sub
78+
help [ <command> ]
8079

8180

8281
> ^C
@@ -172,6 +171,10 @@ It contains multiple paragraphs and should be preceeded by the parameter list.
172171

173172
* None
174173

174+
### v0.3.2
175+
176+
* Shortened help output.
177+
175178
### v0.3.1
176179

177180
* Updated crate metadata

0 commit comments

Comments
 (0)