Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #9

Merged
merged 4 commits into from
Sep 26, 2018
Merged

Update README.md #9

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8e4a5f8
Update README.md
TheIntelloBox Sep 26, 2018
78f9262
Update README.md
TheIntelloBox Sep 26, 2018
61221d3
Update README.md
TheIntelloBox Sep 26, 2018
3fd8ea1
Update README.md
TheIntelloBox Sep 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ It also contains a map of parse exceptions for each command node it encountered.
the reason why is inside this exception map.

## Displaying usage info
There's two forms of "usage strings" provided by this library, both require a target node.
There are two forms of "usage strings" provided by this library, both require a target node.

`getAllUsage(node, source, restricted)` will return a list of all possible commands (executable end-points) under the target node and their human readable path. If `restricted`, it will ignore commands that `source` does not have access to. This will look like [`foo`, `foo <bar>`]

Expand Down