Skip to content

Commit d6a5eaf

Browse files
committed
chore(cli): add USAGE and NOTES section in --help
1 parent d902592 commit d6a5eaf

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

emmylua.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -436,6 +436,7 @@ You can also define a (pseudo) enum using [`---@alias`](#alias).
436436
local U = {}
437437

438438
---@alias VMode
439+
---Vim operator-mode motions. Read `:h map-operator`
439440
---| 'line' Vertical motion
440441
---| 'char' Horizontal motion
441442
---| 'v'
@@ -452,6 +453,7 @@ return U
452453

453454
```help
454455
VMode *VMode*
456+
Vim operator-mode motions. Read `:h map-operator`
455457
456458
Variants: ~
457459
('line') Vertical motion

src/cli.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,14 @@ OPTIONS:
9797
-c, --prefix-class Prefix ---@class tag with return/mod name
9898
-h, --help Print help information
9999
-v, --version Print version information
100+
101+
USAGE:
102+
{NAME} /path/to/first.lua /path/to/second.lua > doc.txt
103+
{NAME} -c -a /path/to/{{first,second,third}}.lua > doc.txt
104+
105+
NOTES:
106+
- The order of parsing + rendering relative to the given files
107+
- Types and Functions will be prefixed with ---@mod name
100108
"
101109
);
102110
}

0 commit comments

Comments
 (0)